Getting started

DocsForge is a self-contained documentation engine. pip install, write Markdown, build.

Installation

pip install docsforge

Requires Python 3.10+.

Quick start

# Create a new project
docsforge new my-docs
cd my-docs

# Start the dev server
docsforge serve

# Build for production
docsforge build

What's inside

After docsforge new, your project looks like this:

my-docs/
├── docsforge.yml    # Site configuration
├── docs/
│   └── index.md     # Homepage
└── site/            # Build output

Configuration

The smallest valid docsforge.yml:

site_name: My Project

That's it. All plugins, extensions, and theme settings use sensible defaults. Add configuration only when you need to customize.

Key defaults

Next steps

• Creating your site
• Reference