[{"data":1,"prerenderedAt":29},["ShallowReactive",2],{"clay-page:\u002F3.x\u002Fguides\u002Fupgrading-to-clay-3":3},{"html":4,"toc":5,"description":25,"hero":26,"list":27,"socialImage":28},"\u003Ch1 id=\"upgrading-to-clay-3\">Upgrading to Clay 3\u003C\u002Fh1>\n\u003Cp>Clay 3 moves three things into the docs themselves: folder names, the start page and older versions. Everything else, your pages, links, translations and the rest of \u003Ccode>clay.yaml\u003C\u002Fcode>, stays as it is. Until you have moved them, \u003Ccode>clay build\u003C\u002Fcode> reports what is left with a warning, and \u003Ccode>--strict\u003C\u002Fcode> fails.\u003C\u002Fp>\n\u003Ch2 id=\"1-update-clay\">\u003Ca class=\"heading-anchor\" href=\"#1-update-clay\" aria-label=\"Link to this section\" data-route=\"#1-update-clay\">#\u003C\u002Fa>1. Update Clay\u003C\u002Fh2>\n\u003Cdiv class=\"code-block is-terminal has-bar\">\u003Cdiv class=\"code-terminal\" aria-hidden=\"true\">\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003C\u002Fdiv>\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 command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">npm\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> install\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#569CD6\"> --save-dev\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> clay-doc@3\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=\"2-folder-names-dir-metayaml--indexmd\">\u003Ca class=\"heading-anchor\" href=\"#2-folder-names-dir-metayaml--indexmd\" aria-label=\"Link to this section\" data-route=\"#2-folder-names-dir-metayaml--indexmd\">#\u003C\u002Fa>2. Folder names: dir-meta.yaml → index.md\u003C\u002Fh2>\n\u003Cp>Each entry of \u003Ccode>dir-meta.yaml\u003C\u002Fcode> becomes the front matter of an \u003Ccode>index.md\u003C\u002Fcode> in that folder. \u003Ccode>name\u003C\u002Fcode> becomes \u003Ccode>title\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cp>\u003Ccode>dir-meta.yaml\u003C\u002Fcode> (Clay 2):\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 style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">- \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">path\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">\"guides\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">  name\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">\"Guides\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">  icon\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">\"fa-solid fa-book-open\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">  order\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#076240;--shiki-dark:#B5CEA8\">3\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\u003Cp>\u003Ccode>docs\u002Fguides\u002Findex.md\u003C\u002Fcode> (Clay 3):\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 style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">---\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">title\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000FF;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#CE9178\">Guides\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">icon\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000FF;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#CE9178\">fa-solid fa-book-open\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">order\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000FF;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#076240;--shiki-dark:#B5CEA8\">3\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">---\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\u003Cp>Names per language (\u003Ccode>name: {en: Guides, de: Anleitungen}\u003C\u002Fcode>) go into translations of the \u003Ccode>index.md\u003C\u002Fcode>: \u003Ccode>index.de.md\u003C\u002Fcode> with \u003Ccode>title: Anleitungen\u003C\u002Fcode>. Then delete \u003Ccode>dir-meta.yaml\u003C\u002Fcode>.\u003C\u002Fp>\n\u003Cp>An \u003Ccode>index.md\u003C\u002Fcode> with only front matter just names its folder. Add text below it, and it becomes the folder’s page; see \u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Forganizing\u002Findex-pages\" data-route=\"\u002F3.x\u002Forganizing\u002Findex-pages\">index pages\u003C\u002Fa>.\u003C\u002Fp>\n\u003Ch2 id=\"3-the-start-page-index-in-clayyaml--docsindexmd\">\u003Ca class=\"heading-anchor\" href=\"#3-the-start-page-index-in-clayyaml--docsindexmd\" aria-label=\"Link to this section\" data-route=\"#3-the-start-page-index-in-clayyaml--docsindexmd\">#\u003C\u002Fa>3. The start page: index in clay.yaml → docs\u002Findex.md\u003C\u002Fh2>\n\u003Cp>The \u003Ccode>index\u003C\u002Fcode> section of \u003Ccode>clay.yaml\u003C\u002Fcode> becomes \u003Ccode>docs\u002Findex.md\u003C\u002Fcode>. For a similar look, a large header and the top-level pages below it, set \u003Ccode>hero\u003C\u002Fcode> and \u003Ccode>list\u003C\u002Fcode>:\u003C\u002Fp>\n\u003Cp>\u003Ccode>clay.yaml\u003C\u002Fcode> (Clay 2):\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 style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">index\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">:\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">  title\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">\"Welcome to My Project\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">  description\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">\"Everything you need to know.\"\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">  icon\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">\"fa-solid fa-rocket\"\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\u003Cp>\u003Ccode>docs\u002Findex.md\u003C\u002Fcode> (Clay 3):\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 style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">---\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">title\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000FF;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#CE9178\">Welcome to My Project\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">description\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000FF;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#CE9178\">Everything you need to know.\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">icon\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000FF;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#CE9178\">fa-solid fa-rocket\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">hero\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000FF;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#569CD6\">true\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#800000;--shiki-dark:#569CD6\">list\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000FF;--shiki-dark:#D4D4D4\">: \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#569CD6\">true\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line\">\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\">---\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\u003Cp>Values per language go into \u003Ccode>docs\u002Findex.de.md\u003C\u002Fcode> and so on. Then remove \u003Ccode>index\u003C\u002Fcode> from \u003Ccode>clay.yaml\u003C\u002Fcode>.\u003C\u002Fp>\n\u003Ch2 id=\"4-older-versions-versions--docs-archive\">\u003Ca class=\"heading-anchor\" href=\"#4-older-versions-versions--docs-archive\" aria-label=\"Link to this section\" data-route=\"#4-older-versions-versions--docs-archive\">#\u003C\u002Fa>4. Older versions: versions\u002F → docs-archive\u002F\u003C\u002Fh2>\n\u003Cp>Older versions move one level up: \u003Ccode>versions\u002F1.x\u002Fdocs\u002F\u003C\u002Fcode> becomes \u003Ccode>docs-archive\u002F1.x\u002F\u003C\u002Fcode>. Their \u003Ccode>dir-meta.yaml\u003C\u002Fcode> turns into \u003Ccode>index.md\u003C\u002Fcode> files as in step 2.\u003C\u002Fp>\n\u003Cdiv class=\"code-block is-terminal has-bar\">\u003Cdiv class=\"code-terminal\" aria-hidden=\"true\">\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003C\u002Fdiv>\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 command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">mkdir\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> docs-archive\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">git\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> mv\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> versions\u002F1.x\u002Fdocs\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> docs-archive\u002F1.x\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=\"5-check\">\u003Ca class=\"heading-anchor\" href=\"#5-check\" aria-label=\"Link to this section\" data-route=\"#5-check\">#\u003C\u002Fa>5. Check\u003C\u002Fh2>\n\u003Cdiv class=\"code-block is-terminal has-bar\">\u003Cdiv class=\"code-terminal\" aria-hidden=\"true\">\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003Cspan>\u003C\u002Fspan>\u003C\u002Fdiv>\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 command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">npx\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> clay\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> build\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#569CD6\"> --strict\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\u003Cp>When the build passes, the upgrade is done. Links to \u003Ccode>index.md\u003C\u002Fcode> files and to folders lead to the folders’ pages, so existing links keep working.\u003C\u002Fp>\n\u003Ch2 id=\"what-else-is-new\">\u003Ca class=\"heading-anchor\" href=\"#what-else-is-new\" aria-label=\"Link to this section\" data-route=\"#what-else-is-new\">#\u003C\u002Fa>What else is new\u003C\u002Fh2>\n\u003Cul>\n\u003Cli>In the sidebar, a folder’s title opens its page; the arrow shows and hides its pages.\u003C\u002Fli>\n\u003Cli>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Forganizing\u002Fclay-edit\" data-route=\"\u002F3.x\u002Forganizing\u002Fclay-edit\">clay edit\u003C\u002Fa> creates, renames, moves and deletes pages and folders, edits all front matter, and works in every version and language.\u003C\u002Fli>\n\u003Cli>Section headings show a \u003Ccode>#\u003C\u002Fcode> link to copy.\u003C\u002Fli>\n\u003C\u002Ful>\n",[6,10,13,16,19,22],{"id":7,"text":8,"level":9},"1-update-clay","1. Update Clay",2,{"id":11,"text":12,"level":9},"2-folder-names-dir-metayaml--indexmd","2. Folder names: dir-meta.yaml → index.md",{"id":14,"text":15,"level":9},"3-the-start-page-index-in-clayyaml--docsindexmd","3. The start page: index in clay.yaml → docs\u002Findex.md",{"id":17,"text":18,"level":9},"4-older-versions-versions--docs-archive","4. Older versions: versions\u002F → docs-archive\u002F",{"id":20,"text":21,"level":9},"5-check","5. Check",{"id":23,"text":24,"level":9},"what-else-is-new","What else is new","Move a Clay 2 site to Clay 3 - index.md files instead of dir-meta.yaml, the start page in docs\u002Findex.md and older versions in docs-archive\u002F.",null,false,"\u002F_clay\u002Fsocial\u002F3.x\u002Fguides\u002Fupgrading-to-clay-3.png",1792666369076]