Configuration

All configuration lives in pookiedocs.config.py at your project root.

from pookiedocs.config import DocsConfig

DOCS = DocsConfig(
    name="My Project",
    docsDir="docs",
    staticDir="static",
    outputDir="dist",
    baseUrl="/",
    fontFamily="system",
)

All fields have sensible defaults. A config file with just name is valid:

from pookiedocs.config import DocsConfig

DOCS = DocsConfig(name="My Project")

Fields

Field	Type	Default	Description
name	str	required	Site name shown in the browser title and sidebar header
docsDir	str	"docs"	Directory containing source markdown and HTML files
staticDir	str	"static"	Directory containing images, downloads, and other assets
outputDir	str	"dist"	Directory for built output
baseUrl	str	"/"	Base URL for all links, useful when deploying to a subdirectory
fontFamily	str	"system"	Font family for body text

fontFamily

Setting fontFamily to "system" uses a neutral system font stack:

-apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif

To use a specific font, set fontFamily to the font name:

DOCS = DocsConfig(
    name="My Project",
    fontFamily="Inter",
)

The named font is applied as the CSS font-family for body text and headings. The system stack is always appended as a fallback, so text remains readable if the font fails to load.

You are responsible for making the font available: either via a stylesheet loaded by your pages, or by using a font that is already available on most visitors' systems.

baseUrl

Use baseUrl when your site is deployed under a subdirectory rather than the domain root:

DOCS = DocsConfig(
    name="My Project",
    baseUrl="/docs/",
)

This prepends /docs/ to all internal links generated by pookiedocs.