Skip to content

Quick Start

Get your documentation up and running in 5 minutes.

1. Initialize Configuration

Navigate to your project root and run:

plissken init

This creates a plissken.toml with auto-detected settings:

[project]
name = "myproject"
version_from = "cargo"  # or "pyproject"

[output]
format = "markdown"
path = "docs/api"
template = "mkdocs-material"

[rust]
crates = ["."]

[python]
package = "mypackage"

2. Generate Documentation

plissken render

This parses your source code and generates Markdown files:

docs/api/
  python/mypackage/...
  rust/mycrate/...
  _nav.yml

3. Set Up MkDocs

Create mkdocs.yml:

site_name: My Project
theme:
  name: material

nav:
  - Home: index.md
  - API Reference:
    - api/index.md
    # Copy entries from docs/api/_nav.yml here

Copy the navigation entries from the generated docs/api/_nav.yml into your mkdocs.yml.

4. Serve Locally

mkdocs serve

Visit http://localhost:8000 to see your docs!

5. Build for Production

mkdocs build

The static site is in site/, ready for deployment.

Next Steps