More ways to use this page
Getting Started
Install Clay, build a first site in five minutes and learn which file does what.
Clay turns a folder of Markdown files into a documentation website. You write pages in docs/, describe the site in clay.yaml, and Clay builds static files you can publish anywhere. No templates, no theme to configure, no JavaScript to write.
| If you want to … | Read |
|---|---|
| Add Clay to a project, or try it without installing | Installation |
| Go from an empty folder to a finished site | Quick Start |
| Know what each file and folder of a project is for | Project Structure |
#What you need
- Node.js and npm
- A folder of Markdown files, or the wish to write some
- A text editor;
clay devshows every change in the browser right away
Tip
Already know Clay 2? Skip ahead to upgrading to Clay 3.