Getting Started

Development

Set up your local development environment.

Local development

Run the development server to preview changes in real time:

example-cli dev

The development server includes:

• Hot reloading — Changes appear instantly in the browser
• Error overlay — Syntax errors are displayed inline
• Link checking — Broken links are flagged during development

Project structure

A typical project has this structure:

my-project/
├── docs/
│   ├── getting-started/
│   │   ├── index.md
│   │   └── quickstart.md
│   ├── essentials/
│   │   ├── text.md
│   │   └── code.md
│   └── components/
│       ├── callouts.md
│       └── tabs.md
├── static/
│   └── images/
├── config.json
└── package.json

Configuration

The config.json file controls your site's settings:

{
  "name": "My Documentation",
  "navigation": [
    {
      "group": "Getting Started",
      "pages": ["getting-started/index", "getting-started/quickstart"]
    }
  ]
}

Troubleshooting

Port already in use

If port 3000 is already in use, specify a different port:

example-cli dev --port 3001

Build errors

Clear the cache and rebuild:

example-cli clean
example-cli dev