Introduction

Clay turns a folder of Markdown files into a fast, searchable documentation website. You write pages in Markdown, describe your site in one small configuration file, and Clay builds a static site that you can host anywhere: GitHub Pages, Netlify, Cloudflare Pages or any web server.

This website is itself a Clay site. Every page you read here is a Markdown file in the example repository, and the repository doubles as a reference you can copy from.

#How it works

A Clay project is a folder with a configuration file and your docs:

You work with three commands:

npx clay dev       # live preview while you write
npx clay build     # build the static site into publish/public
npx clay preview   # check the build the way a web host serves it

Clay is a single npm package, clay-doc. It builds on Nuxt and Vue, but you never touch either: there is no theme to set up and no code to write.

#What you get

Every page is pre-rendered to HTML: it loads fast, works without JavaScript and fits small screens, with the navigation in a drawer.

#Where to go next