Building
pookiedocs build
What the build command does
- Reads
pookiedocs.config.py - Scans
docsDirrecursively - Converts all markdown files to HTML
- Passes all HTML files through the theme wrapper
- Generates the navigation tree
- Generates
search-index.json - Copies
staticDircontents tooutputDir/static/ - Copies theme assets to
outputDir/assets/ - Writes all output to
outputDir
Output
Building...
Converted 12 pages
Generated search index
Copied theme assets
Output: dist/
Options
Override the output directory without changing your config:
pookiedocs build --output myfolder
Use an alternate config file:
pookiedocs build --config path/to/pookiedocs.config.py
Stale files
If outputDir already exists, pookiedocs clears it completely before writing. No stale files from previous builds are left behind.
Serving the output
There are three ways to serve the built site depending on your use case:
| Use case | Command |
|---|---|
| Local development with live reload | pookiedocs dev |
| Production server (Docker, VPS, containers) | pookiedocs serve |
| Static file host (Cloudflare, Netlify, GitHub Pages) | pookiedocs build then deploy dist/ |
See the Deployment guide for step-by-step instructions.