Quick Start

1. Create a documentation project#

Install the CLI, create a folder, and initialize your site:

Bash

pnpm add -g @clidey/dory
mkdir my-docs
cd my-docs
dory init

dory init creates dory.json, docs/introduction.mdx, and a starter logo. Keep your pages in docs/ and add their page keys to dory.json navigation.

2. Write with a live preview#

Bash

dory dev

Open the local URL shown in your terminal. Changes to your MDX files reload while you write.

3. Check the whole site#

Bash

dory check

The check reports missing navigation pages, broken local links and anchors, missing assets, and invalid frontmatter. Run it in CI before publishing.

4. Build and preview#

Bash

dory build
dory preview

The static site is written to dist/. The build accepts a top-level docs/ folder and does not modify the installed Dory package. dory preview also serves the optional documentation chat when you configure a model on the server.

Next steps#

Configuration

Customize navigation, branding, and metadata.

Components

Add richer examples to your pages.

Languages and versions

Organize translated and versioned content.

Documentation chat

Add an optional cited assistant.

Was this page helpful?