Quickstart

Get a documentation site running locally in five minutes.

Prerequisites

Docyard requires Ruby 3.2 or higher.

brew install ruby

# Ubuntu/Debian
sudo apt update && sudo apt install ruby-full

# Fedora
sudo dnf install ruby

wsl --install

sudo apt update && sudo apt install ruby-full

Verify your Ruby version:

ruby -v

Install Docyard

gem install docyard

Verify the installation:

docyard version

Create a Project

docyard init my-docs
cd my-docs

This creates a new directory with your configuration and starter pages.

Start the Server

docyard serve

Open http://localhost:4200 in your browser. You should see your new documentation site.

Edit Your First Page

Open docs/getting-started.md in your editor. Make a change, save the file, and watch it update in the browser.

Try adding a callout:

:::note
This is my first Docyard site!
:::

Build for Production

When you’re ready to deploy:

docyard build

This generates a dist/ directory containing static HTML, CSS, and JavaScript. Upload these files to any web host.

What’s Next