Generated from docs.yaml

Example docs

This sample documentation site shows the shape of generated output. Replace the placeholder package, guides, and source paths with your real project.

uv add example-package

3Guide pages

8API objects

1Static site

Docs / Guide

Guide overview

Markdown files become navigable documentation pages with clean hierarchy and source-shaped structure.

1Install
Add the package and CLI.

2Configure
Point Folio at docs and Python source.

3Publish
Export a static Nextra site.

Reference / CLI

Build the docs and start a local preview server with the same command you will use while editing.

terminallocal preview

folio serve --port 4321
Scanning Python source...
Generating pages...
Ready at localhost:4321

Configuration

The config connects Python source, Markdown guides, plugins, and static output.

docs.yamlsource map

source:
  python:
    paths:
      - "src/example_package"
  docs:
    - "docs"

API / example_package.arithmetic

add(left: int, right: int) -> int

MDX components

Callout

Use components where prose needs a clearer shape.

Code

add(2, 3)

Tabs

Show variants without turning the guide into an app.