Quickstart

From nothing to a running documentation site in four commands.

Requires Python 3.10+ and Node.js 18+.

Install

pip install deepdoc

Point it at your repository

cd your-project
deepdoc init --provider anthropic

Writes .deepdoc.yaml. Set your API key:

export ANTHROPIC_API_KEY=sk-...

Generate

deepdoc generate

Scans the repository, plans the structure, and writes Markdown into deepdoc-docs/.

Preview

deepdoc serve

Opens http://localhost:3000.

Next

Make it yours

Brand colours, logo and fonts.

What it costs

Which commands call an LLM, and which are free.

What DeepDoc does

Point it at a repository. Get a documentation site you can brand, theme and ship.

Your first site

What DeepDoc just created, how to read it, and which parts are yours to edit.

On this page

InstallPoint it at your repositoryGeneratePreviewNext