Quickstart

Three commands to a running docs site.

gem install docyard -v 1.3.0

docyard init my-docs
cd my-docs

docyard serve

Make a change

Open docs/getting-started.md, edit something, save. The browser updates automatically.

Try adding a component:

:::note
Docyard supports callouts, tabs, steps, and more.
:::

Build for production

docyard build

Static files are generated in dist/. Deploy to any host.

Need Ruby?

Docyard requires Ruby 3.2+. Check your version:

ruby -v

If you need to install or upgrade Ruby, see the official Ruby installation guide.