Files
tolaria/reference/file-layout.html

39 lines
34 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>File Layout | Tolaria</title>
<meta name="description" content="Tolaria is a local-first Markdown knowledge base with native relationships, Git history, and AI workflows.">
<meta name="generator" content="VitePress v1.6.4">
<link rel="preload stylesheet" href="/tolaria/assets/style.DeVPLYtG.css" as="style">
<link rel="preload stylesheet" href="/tolaria/vp-icons.css" as="style">
<script type="module" src="/tolaria/assets/app.D3snHqQg.js"></script>
<link rel="preload" href="/tolaria/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/tolaria/assets/chunks/theme.RsTuzNU8.js">
<link rel="modulepreload" href="/tolaria/assets/chunks/framework.B8zgMDLd.js">
<link rel="modulepreload" href="/tolaria/assets/reference_file-layout.md.DMB3wGMi.lean.js">
<link rel="icon" type="image/png" href="/tolaria/landing/favicon.png">
<meta property="og:title" content="Tolaria">
<meta property="og:description" content="A second brain for the AI era. Free forever, local-first, Markdown-based, Git-ready, and AI-friendly.">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="" data-v-0418e6e1><div class="Layout" data-v-0418e6e1 data-v-ccf76b0c><!--[--><!--]--><!--[--><span tabindex="-1" data-v-3cf742b9></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-3cf742b9>Skip to content</a><!--]--><!----><header class="VPNav" data-v-ccf76b0c data-v-e1256463><div class="VPNavBar" data-v-e1256463 data-v-c0d22204><div class="wrapper" data-v-c0d22204><div class="container" data-v-c0d22204><div class="title" data-v-c0d22204><div class="VPNavBarTitle has-sidebar" data-v-c0d22204 data-v-ca0cf389><a class="title" href="/tolaria/" data-v-ca0cf389><!--[--><!--]--><!--[--><img class="VPImage logo" src="/tolaria/landing/tolaria-icon.png" alt="Tolaria" data-v-deda50b0><!--]--><span data-v-ca0cf389>Tolaria</span><!--[--><!--]--></a></div></div><div class="content" data-v-c0d22204><div class="content-body" data-v-c0d22204><!--[--><!--]--><div class="VPNavBarSearch search" data-v-c0d22204><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-c0d22204 data-v-5594a541><span id="main-nav-aria-label" class="visually-hidden" data-v-5594a541> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/tolaria/start/install" tabindex="0" data-v-5594a541 data-v-75347875><!--[--><span data-v-75347875>Start</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/tolaria/concepts/vaults" tabindex="0" data-v-5594a541 data-v-75347875><!--[--><span data-v-75347875>Concepts</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/tolaria/guides/capture-a-note" tabindex="0" data-v-5594a541 data-v-75347875><!--[--><span data-v-75347875>Guides</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon no-icon VPNavBarMenuLink" href="https://tolaria.md/download/" target="_self" rel="noreferrer" tabindex="0" data-v-5594a541 data-v-75347875><!--[--><span data-v-75347875>Downloads</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-c0d22204 data-v-cbc799be><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-cbc799be data-v-177cfd24 data-v-7f73ba5a><span class="check" data-v-7f73ba5a><span class="icon" data-v-7f73ba5a><!--[--><span class="vpi-sun sun" data-v-177cfd24></span><span class="vpi-moon moon" data-v-177cfd24></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-c0d22204 data-v-6da53269 data-v-b8c36a12><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-b8c36a12><span class="vpi-more-horizontal icon" data-v-b8c36a12></span></button><div class="menu" data-v-b8c36a12><div class="VPMenu" data-v-b8c36a12 data-v-a8c21b34><!----><!--[--><!--[--><!----><div class="group" data-v-6da53269><div class="item appearance" data-v-6da53269><p class="label" data-v-6da53269>Appearance</p><div class="appearance-action" data-v-6da53269><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-6da53269 data-v-177cfd24 data-v-7f73ba5a><span class="check" data-v-7f73ba5a><span class="icon" data-v-7f73ba5a><!--[--><span class="vpi-sun sun" data-v-177cfd24></span><span class="vpi-moon moon" data-v-177cfd24></span><!--]--></span></span></button></div></div></div><!----><!--]--><!--]--></div></div></div><!--[--><!--[--><!--[--><a class="github-star-widget" href="https://github.com/refactoringhq/tolaria" target="_blank" rel="noreferrer" aria-label="9,946 GitHub stars" data-v-0418e6e1><svg viewBox="0 0 24 24" aria-hidden="true" d
<span class="line"><span> project-alpha.md</span></span>
<span class="line"><span> weekly-review.md</span></span>
<span class="line"><span> research/</span></span>
<span class="line"><span> source-notes.md</span></span>
<span class="line"><span> attachments/</span></span>
<span class="line"><span> diagram.png</span></span>
<span class="line"><span> source.pdf</span></span>
<span class="line"><span> project.md</span></span>
<span class="line"><span> person.md</span></span>
<span class="line"><span> views/</span></span>
<span class="line"><span> active-projects.yml</span></span></code></pre></div><h2 id="root-notes" tabindex="-1">Root Notes <a class="header-anchor" href="#root-notes" aria-label="Permalink to &quot;Root Notes&quot;"></a></h2><p>Tolaria works well with a flat vault. Folders are optional and can be useful for compatibility with other tools, but they are not required for people, projects, topics, or any other note category.</p><p>Type is not inferred from folder location. It comes from frontmatter, and relationships are expressed with wikilinks in fields. That is what Tolaria uses for the sidebar, Properties panel, search, custom views, and neighborhood navigation.</p><h2 id="special-folders" tabindex="-1">Special Folders <a class="header-anchor" href="#special-folders" aria-label="Permalink to &quot;Special Folders&quot;"></a></h2><table tabindex="0"><thead><tr><th>Folder</th><th>Purpose</th></tr></thead><tbody><tr><td><code>views/</code></td><td>Saved custom views.</td></tr><tr><td><code>attachments/</code></td><td>Images and other attached files.</td></tr></tbody></table><p>PDFs, images, and other non-Markdown files stay as normal files. Folder browsing can show them in place, and Settings controls whether PDFs, images, and unsupported files appear in All Notes.</p><p>Whiteboards are Markdown files with durable tldraw data, so they belong with notes rather than in <code>attachments/</code>.</p><p>Type definitions are Markdown notes with <code>type: Type</code> in frontmatter. New type documents are normal notes, and existing type documents in older folders still work.</p><h2 id="git-files" tabindex="-1">Git Files <a class="header-anchor" href="#git-files" aria-label="Permalink to &quot;Git Files&quot;"></a></h2><p>If the vault is a Git repository, <code>.git/</code> belongs to Git. Tolaria reads Git state but does not treat <code>.git/</code> as notes.</p></div></div></main><footer class="VPDocFooter" data-v-478bd20d data-v-f76ba9a2><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-f76ba9a2><span class="visually-hidden" id="doc-footer-aria-label" data-v-f76ba9a2>Pager</span><div class="pager" data-v-f76ba9a2><a class="VPLink link pager-link prev" href="/tolaria/reference/supported-platforms" data-v-f76ba9a2><!--[--><span class="desc" data-v-f76ba9a2>Previous page</span><span class="title" data-v-f76ba9a2>Supported Platforms</span><!--]--></a></div><div class="pager" data-v-f76ba9a2><a class="VPLink link pager-link next" href="/tolaria/reference/frontmatter-fields" data-v-f76ba9a2><!--[--><span class="desc" data-v-f76ba9a2>Next page</span><span class="title" data-v-f76ba9a2>Frontmatter Fields</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-ccf76b0c data-v-d4c9b439><div class="container" data-v-d4c9b439><p class="message" data-v-d4c9b439>Free and open source. Local-first, Git-first, and Markdown-based.</p><p class="copyright" data-v-d4c9b439>Tolaria is AGPL-3.0-or-later. The Tolaria name and logo remain covered by the project trademark policy.</p></div></footer><!--[--><!--]--></div></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"concepts_ai.md\":\"DIK5Bfg0\",\"concepts_editor.md\":\"DDUR8n9t\",\"concepts_files-and-media.md\":\"jX80SLTG\",\"concepts_git.md\":\"BAdh_mgD\",\"concepts_inbox.md\":\"CzCPstDV\",\"concepts_notes.md\":\"DX6CEnZw\",\"concepts_properties.md\":\"BTp_DHwu\",\"concepts_relationships.md\":\"CZTaFK8t\",\"concepts_types.md\":\"B9gDL46C\",\"concepts_vaults.md\":\"7tXSQetT\",\"guides_build-custom-views.md\":\"oCcwiwDP\",\"guides_capture-a-note.md\":\"CfOFL1pV\",\"guides_commit-and-push.md\":\"WqBsFxVF\",\"guides_configure-ai-models.md\":\"oqs2LK21\",\"guides_connect-a-git-remote.md\":\"BT1nd6kx\",\"guides_create-types.md\":\"BjgkIAtx\",\"guides_manage-display-preferences.md\":\"Cmlhde-y\",\"guides_organize-inbox.md\":\"CLKjBs0A\",\"guides_use-ai-panel.md\":\"CCGF9Z77\",\"guides_use-command-palette.md\":\"D_4Y1cpH\",\"guides_use-media-previews.md\":\"DqtjkXGv\",\"guides_use-table-of-contents.md\":\"DLxDCHlk\",\"guides_use-wikilinks.md\":\"Bqv-MgHa\",\"index.md\":\"xM_F9V47\",\"reference_contribute.md\":\"DDG61uai\",\"reference_docs-maintenance.md\":\"CxWfNbSy\",\"reference_file-layout.md\":\"DMB3wGMi\",\"reference_frontmatter-fields.md\":\"BXs6ltCP\",\"reference_keyboard-shortcuts.md\":\"DTu7rSXc\",\"reference_release-channels.md\":\"BHJSdq9n\",\"reference_supported-platforms.md\":\"rcg1mjBb\",\"reference_view-filters.md\":\"BuqSkghY\",\"releases_index.md\":\"D8vM7F3s\",\"start_first-launch.md\":\"C4JHn84l\",\"start_getting-started-vault.md\":\"DKLagf0T\",\"start_install.md\":\"JLbPS-fo\",\"start_open-or-create-vault.md\":\"y8pmm3eh\",\"troubleshooting_ai-agent-not-found.md\":\"C3Mmb3f1\",\"troubleshooting_git-auth.md\":\"CsDi28bX\",\"troubleshooting_model-provider-connection.md\":\"B3tnyRFn\",\"troubleshooting_sync-conflicts.md\":\"DJwnCtF5\",\"troubleshooting_vault-not-loading.md\":\"hQzvZm3Q\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Tolaria\",\"description\":\"Tolaria is a local-first Markdown knowledge base with native relationships, Git history, and AI workflows.\",\"base\":\"/tolaria/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":{\"src\":\"/landing/tolaria-icon.png\",\"alt\":\"Tolaria\"},\"nav\":[{\"text\":\"Start\",\"link\":\"/start/install\"},{\"text\":\"Concepts\",\"link\":\"/concepts/vaults\"},{\"text\":\"Guides\",\"link\":\"/guides/capture-a-note\"},{\"text\":\"Downloads\",\"link\":\"https://tolaria.md/download/\",\"target\":\"_self\",\"noIcon\":true}],\"search\":{\"provider\":\"local\"},\"sidebar\":[{\"text\":\"Start Here\",\"items\":[{\"text\":\"Install Tolaria\",\"link\":\"/start/install\"},{\"text\":\"First Launch\",\"link\":\"/start/first-launch\"},{\"text\":\"Getting Started Vault\",\"link\":\"/start/getting-started-vault\"},{\"text\":\"Open Or Create A Vault\",\"link\":\"/start/open-or-create-vault\"}]},{\"text\":\"Concepts\",\"items\":[{\"text\":\"Vaults\",\"link\":\"/concepts/vaults\"},{\"text\":\"Notes\",\"link\":\"/concepts/notes\"},{\"text\":\"Editor\",\"link\":\"/concepts/editor\"},{\"text\":\"Properties\",\"link\":\"/concepts/properties\"},{\"text\":\"Types\",\"link\":\"/concepts/types\"},{\"text\":\"Relationships\",\"link\":\"/concepts/relationships\"},{\"text\":\"Files And Media\",\"link\":\"/concepts/files-and-media\"},{\"text\":\"Inbox\",\"link\":\"/concepts/inbox\"},{\"text\":\"Git\",\"link\":\"/concepts/git\"},{\"text\":\"AI\",\"link\":\"/concepts/ai\"}]},{\"text\":\"Guides\",\"items\":[{\"text\":\"Capture A Note\",\"link\":\"/guides/capture-a-note\"},{\"text\":\"Organize The Inbox\",\"link\":\"/guides/organize-inbox\"},{\"text\":\"Use Wikilinks\",\"link\":\"/guides/use-wikilinks\"},{\"text\":\"Create Types\",\"link\":\"/guides/create-types\"},{\"text\":\"Build Custom Views\",\"link\":\"/guides/build-custom-views\"},{\"text\":\"Connect A Git Remote\",\"link\":\"/guides/connect-a-git-remote\"},{\"text\":\"Manage Git\",\"link\":\"/guides/commit-and-push\"},{\"text\":\"Use The AI\",\"link\":\"/guides/use-ai-panel\"},{\"text\":\"Configure AI Models\",\"link\"
</body>
</html>