Get started

Get started

Quickstart

From nothing to a running documentation site in four commands.


You need Python 3.10 or newer and Node.js 18 or newer. The chatbot extra additionally needs Python 3.10 to 3.14 (3.10 to 3.13 on an Intel Mac) for now.

Install

pip install deepdoc

Point it at your repository

cd your-project
deepdoc init --provider anthropic

This writes .deepdoc.yaml. Set the API key for your provider:

export ANTHROPIC_API_KEY=sk-ant-...

No key handy? Use DeepDoc Cloud, or run a local model with --provider ollama.

Generate

deepdoc generate

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

Preview

deepdoc serve

Opens http://localhost:3000. The first run installs the site’s npm dependencies.

After your first run

  • Commit .deepdoc.yaml and .deepdoc/. The saved plan is what makes theming and updates cheap.
  • Run deepdoc update after commits instead of generate. See Keeping docs fresh.
  • Run deepdoc deploy when you are ready to publish. See Deploying.

Edit this page on GitHub