[{"data":1,"prerenderedAt":22},["ShallowReactive",2],{"clay-page:\u002F3.x":3},{"html":4,"toc":5,"description":16,"hero":17,"list":20,"socialImage":21},"\u003Cp>Clay turns a folder of Markdown files into a documentation website: a sidebar from your folders, full-text search, code highlighting, light and dark themes, versions and translations. You write the pages; Clay does the rest.\u003C\u002Fp>\n\u003Ch2 id=\"start-in-a-minute\">\u003Ca class=\"heading-anchor\" href=\"#start-in-a-minute\" aria-label=\"Link to this section\" data-route=\"#start-in-a-minute\">#\u003C\u002Fa>Start in a minute\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\"> init\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#0000FF;--shiki-dark:#569CD6\"> -y\u003C\u002Fspan>\u003C\u002Fspan>\n\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\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">echo\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> 'title: \"My Project\"'\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\"> > \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">clay.yaml\u003C\u002Fspan>\u003C\u002Fspan>\n\u003Cspan class=\"line command\">\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">mkdir\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> docs\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\"> && \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#695221;--shiki-dark:#DCDCAA\">echo\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\"> '# Hello, Clay'\u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#000000;--shiki-dark:#D4D4D4\"> > \u003C\u002Fspan>\u003Cspan style=\"--shiki-light:#A31515;--shiki-dark:#CE9178\">docs\u002Findex.md\u003C\u002Fspan>\u003C\u002Fspan>\n\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\"> dev\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>Open \u003Ca href=\"http:\u002F\u002Flocalhost:3000\" target=\"_blank\" rel=\"noopener noreferrer\">\u003Ci class=\"fa-solid fa-arrow-up-right-from-square clay-external-icon\" aria-hidden=\"true\">\u003C\u002Fi>http:\u002F\u002Flocalhost:3000\u003C\u002Fa>, and every change you save shows up right away. The \u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fgetting-started\u002Fquick-start\" data-route=\"\u002F3.x\u002Fgetting-started\u002Fquick-start\">quick start\u003C\u002Fa> takes it from there.\u003C\u002Fp>\n\u003Ch2 id=\"why-clay\">\u003Ca class=\"heading-anchor\" href=\"#why-clay\" aria-label=\"Link to this section\" data-route=\"#why-clay\">#\u003C\u002Fa>Why Clay\u003C\u002Fh2>\n\u003Cul>\n\u003Cli>\u003Cstrong>Markdown in, website out.\u003C\u002Fstrong> Pages are Markdown files in \u003Ccode>docs\u002F\u003C\u002Fcode>, folders become the navigation. No templates, no theme to build.\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Search built in.\u003C\u002Fstrong> Every page and section is searchable, typos and all, with \u003Ckbd>Ctrl\u003C\u002Fkbd> + \u003Ckbd>K\u003C\u002Fkbd> or \u003Ckbd>⌘\u003C\u002Fkbd> + \u003Ckbd>K\u003C\u002Fkbd>.\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Fast anywhere.\u003C\u002Fstrong> Every page is pre-rendered to HTML. Host it on GitHub Pages, Netlify or any web server.\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Checked on every build.\u003C\u002Fstrong> Broken links and unknown settings are reported, and \u003Ccode>--strict\u003C\u002Fcode> stops a deploy that has them.\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Versions and languages.\u003C\u002Fstrong> Keep the docs of older releases online and translate page by page.\u003C\u002Fli>\n\u003Cli>\u003Cstrong>Organized in the terminal.\u003C\u002Fstrong> \u003Ccode>clay edit\u003C\u002Fcode> creates, orders, renames and translates pages without touching front matter by hand.\u003C\u002Fli>\n\u003C\u002Ful>\n\u003Ch2 id=\"find-your-way\">\u003Ca class=\"heading-anchor\" href=\"#find-your-way\" aria-label=\"Link to this section\" data-route=\"#find-your-way\">#\u003C\u002Fa>Find your way\u003C\u002Fh2>\n\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>I want to …\u003C\u002Fth>\n\u003Cth>Start with\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\u003Ctr>\n\u003Ctd>See what Clay is and how a site comes together\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fintroduction\" data-route=\"\u002F3.x\u002Fintroduction\">Introduction\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Build a first site, step by step\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fgetting-started\u002Fquick-start\" data-route=\"\u002F3.x\u002Fgetting-started\u002Fquick-start\">Quick Start\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Write pages with code, alerts, links and images\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fwriting\" data-route=\"\u002F3.x\u002Fwriting\">Writing\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Arrange pages and folders\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Forganizing\" data-route=\"\u002F3.x\u002Forganizing\">Organizing\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Look up a setting\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fconfiguration\" data-route=\"\u002F3.x\u002Fconfiguration\">Configuration\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Put the site online\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fdeployment\" data-route=\"\u002F3.x\u002Fdeployment\">Deployment\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Move a Clay 2 site to Clay 3\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fclay-example-repo\u002F3.x\u002Fguides\u002Fupgrading-to-clay-3\" data-route=\"\u002F3.x\u002Fguides\u002Fupgrading-to-clay-3\">Upgrading to Clay 3\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\u003C\u002Ftable>\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>This website is a Clay site. Every page is a Markdown file in the \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Fclay-doc\u002Fclay-example-repo\" target=\"_blank\" rel=\"noopener noreferrer\">\u003Ci class=\"fa-solid fa-arrow-up-right-from-square clay-external-icon\" aria-hidden=\"true\">\u003C\u002Fi>example repository\u003C\u002Fa>: see how it is made, or copy it as a starting point.\u003C\u002Fp>\n\u003C\u002Fdiv>\n",[6,10,13],{"id":7,"text":8,"level":9},"start-in-a-minute","Start in a minute",2,{"id":11,"text":12,"level":9},"why-clay","Why Clay",{"id":14,"text":15,"level":9},"find-your-way","Find your way","Turn a folder of Markdown files into a fast, searchable documentation website. Everything you need to write, organize and publish docs with Clay.",{"title":18,"icon":19,"description":16},"Clay Documentation","fa-solid fa-book-open",true,"\u002F_clay\u002Fsocial\u002F3.x.png",1792666348895]