Getting Started

Get your documentation site running in under 5 minutes.

Quick Start

Get your documentation site running in under 5 minutes. Choose your preferred method:

Download

After downloading:

Windows:

.\dorcs-windows-amd64.exe 

Linux:

# Make it executable
chmod +x dorcs-linux-amd64.exe

# Run dorcs
./dorcs-linux-amd64.exe 

Visit http://localhost:8080 to see your documentation!

Your First Documentation

The easiest way to get started is using the init command, which sets up everything for you:

1. Initialize your documentation site:

./dorcs init

Also see the Commands page for more information.

2. Start the development server:

./dorcs --watch

3. Open your browser

Navigate to http://localhost:8080

You’ll see your new documentation site with a welcome page! Edit docs/index.md to customize your homepage.

File Structure

dorcs uses extensionless URLs that map directly to your file structure: