Getting Started

This guide gets a local docs site running with the fewest steps.

1. Create a docs site

dorcs init

This creates:

• docs/index.md
• a starter dorcs.yaml in your working directory if one does not already exist

2. Start the server

dorcs --watch

Open http://localhost:8080.

--watch rebuilds navigation and reloads the browser when Markdown or config files change.

3. Edit content

Start with docs/index.md:

# Welcome

Your docs live in plain Markdown files.

Add a second page:

docs/
├── index.md
└── guide.md

docs/guide.md becomes /guide.

4. Build static output

dorcs build

This writes a deployable site to dist/ by default.

5. Know the routing model

Next steps

• Use Installation if you still need the binary
• Use Configuration to set title, theme, and navigation
• Use Writing Your Docs for structure and linking guidance