[{"data":1,"prerenderedAt":20},["ShallowReactive",2],{"clay-page:\u002F3.x\u002Fgetting-started\u002Fproject-structure":3},{"html":4,"toc":5,"description":16,"hero":17,"list":18,"socialImage":19},"\u003Ch1 id=\"project-structure\">Project Structure\u003C\u002Fh1>\n\u003Cp>A Clay project has a fixed layout. Clay looks for its files in the project folder: the folder you run \u003Ccode>clay\u003C\u002Fcode> in, or the one you pass with \u003Ccode>--root\u003C\u002Fcode>.\u003C\u002Fp>\n\u003Cdiv class=\"code-block\">\u003Cpre class=\"shiki shiki-themes light-plus dark-plus\" style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4;--shiki-light-bg:#FFFFFF;--shiki-dark-bg:#1E1E1E\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan>my-project\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>├── clay.yaml              # required: site settings\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>├── logo.svg               # optional: logo and favicon, referenced in clay.yaml\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>├── docs\u002F                  # required: the pages of the current version\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   ├── index.md           # optional: the start page\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   ├── introduction.md\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   ├── introduction.de.md # optional: a translation\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   └── guides\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│       ├── index.md       # optional: the folder's name, icon, order and page\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│       ├── setup.md\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│       └── img\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│           └── screen.png # images and files are published as they are\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>├── docs-archive\u002F          # optional: older versions of the docs\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>│   └── 1.x\u002F               # a copy of docs\u002F as it was for version 1.x\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>├── package.json           # optional: Clay as a dev dependency\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>└── publish\u002F               # created by clay build; do not commit\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cbutton type=\"button\" class=\"copy-code btn btn-sm btn-square btn-ghost\" title=\"Copy code\" aria-label=\"Copy code\">\u003Ci class=\"fa-solid fa-copy\">\u003C\u002Fi>\u003C\u002Fbutton>\u003C\u002Fdiv>\n\u003Ch2 id=\"what-each-part-does\">\u003Ca class=\"heading-anchor\" href=\"#what-each-part-does\" aria-label=\"Link to this section\" data-route=\"#what-each-part-does\">#\u003C\u002Fa>What each part does\u003C\u002Fh2>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>Path\u003C\u002Fth>\n\u003Cth>Purpose\u003C\u002Fth>\n\u003Cth>Read more\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\u003Ctr>\n\u003Ctd>\u003Ccode>clay.yaml\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>Title, base URL, navbar links, languages\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fconfiguration\u002Fclay-yaml\" data-route=\"\u002F3.x\u002Fconfiguration\u002Fclay-yaml\">clay.yaml\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>index.md\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>The start page (\u003Ccode>docs\u002Findex.md\u003C\u002Fcode>), and a folder’s name, icon, order and page\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Forganizing\u002Findex-pages\" data-route=\"\u002F3.x\u002Forganizing\u002Findex-pages\">index pages\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>docs\u002F\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>Every \u003Ccode>.md\u003C\u002Fcode> file is a page; other files are published as assets\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fwriting\u002Fpages\" data-route=\"\u002F3.x\u002Fwriting\u002Fpages\">pages\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>*.de.md\u003C\u002Fcode> and similar\u003C\u002Ftd>\n\u003Ctd>Translations of the page next to them\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fversions-and-languages\u002Ftranslations\" data-route=\"\u002F3.x\u002Fversions-and-languages\u002Ftranslations\">translations\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>docs-archive\u002F<name>\u002F\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>A saved copy of the docs of an older release\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fversions-and-languages\u002Fversions\" data-route=\"\u002F3.x\u002Fversions-and-languages\u002Fversions\">versions\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>\u003Ccode>publish\u002Fpublic\u002F\u003C\u002Fcode>\u003C\u002Ftd>\n\u003Ctd>The finished website\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fcli\u002Fcommands\" data-route=\"\u002F3.x\u002Fcli\u002Fcommands\">commands\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\u003C\u002Ftable>\n\u003Ch2 id=\"rules-for-the-docs-folder\">\u003Ca class=\"heading-anchor\" href=\"#rules-for-the-docs-folder\" aria-label=\"Link to this section\" data-route=\"#rules-for-the-docs-folder\">#\u003C\u002Fa>Rules for the docs folder\u003C\u002Fh2>\n\u003Cul>\n\u003Cli>Every Markdown file (\u003Ccode>.md\u003C\u002Fcode>) becomes a page. Its path becomes its URL: \u003Ccode>docs\u002Fguides\u002Fsetup.md\u003C\u002Fcode> is served at \u003Ccode>\u002Fguides\u002Fsetup\u003C\u002Fcode>.\u003C\u002Fli>\n\u003Cli>Folders become sections in the navigation. A folder only appears when it contains at least one page, at any depth.\u003C\u002Fli>\n\u003Cli>Every other file, such as images, PDFs or downloads, is copied into the site as it is, so pages can link to it.\u003C\u002Fli>\n\u003Cli>Files and folders whose names start with a dot (\u003Ccode>.DS_Store\u003C\u002Fcode>, \u003Ccode>.git\u003C\u002Fcode>) are ignored.\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"what-belongs-in-git\">\u003Ca class=\"heading-anchor\" href=\"#what-belongs-in-git\" aria-label=\"Link to this section\" data-route=\"#what-belongs-in-git\">#\u003C\u002Fa>What belongs in git\u003C\u002Fh2>\n\u003Cp>Commit \u003Ccode>clay.yaml\u003C\u002Fcode>, \u003Ccode>docs\u002F\u003C\u002Fcode>, \u003Ccode>docs-archive\u002F\u003C\u002Fcode>, your logo, and \u003Ccode>package.json\u003C\u002Fcode> with \u003Ccode>package-lock.json\u003C\u002Fcode>. Do not commit the build output or the dependencies:\u003C\u002Fp>\n\u003Cdiv class=\"code-block\">\u003Cpre class=\"shiki shiki-themes light-plus dark-plus\" style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4;--shiki-light-bg:#FFFFFF;--shiki-dark-bg:#1E1E1E\" tabindex=\"0\">\u003Ccode>\u003Cspan class=\"line\">\u003Cspan># .gitignore\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>node_modules\u002F\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan>publish\u002F\u003C\u002Fspan>\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003Cbutton type=\"button\" class=\"copy-code btn btn-sm btn-square btn-ghost\" title=\"Copy code\" aria-label=\"Copy code\">\u003Ci class=\"fa-solid fa-copy\">\u003C\u002Fi>\u003C\u002Fbutton>\u003C\u002Fdiv>\n\u003Cdiv class=\"markdown-alert markdown-alert-tip\">\n\u003Cp class=\"markdown-alert-title text-primary\">\u003Ci class=\"fa-solid fa-lightbulb mr-2\">\u003C\u002Fi>Tip\u003C\u002Fp>\n\u003Cp>Clay shows when each page was last changed, taken from git. Keep the docs in a git repository, and check out the full history in CI, to get those dates. See \u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Ffeatures\u002Fpage-details\" data-route=\"\u002F3.x\u002Ffeatures\u002Fpage-details\">page details\u003C\u002Fa>.\u003C\u002Fp>\n\u003C\u002Fdiv>\n",[6,10,13],{"id":7,"text":8,"level":9},"what-each-part-does","What each part does",2,{"id":11,"text":12,"level":9},"rules-for-the-docs-folder","Rules for the docs folder",{"id":14,"text":15,"level":9},"what-belongs-in-git","What belongs in git","The files of a Clay project, what each one does and what belongs in git.",null,false,"\u002F_clay\u002Fsocial\u002F3.x\u002Fgetting-started\u002Fproject-structure.png",1792666368825]