Fr-docs

Fr-docs is a generic, configurable documentation builder for Python projects. It converts Markdown source files into a searchable, optimized static HTML site with zero-config setup.

Quick Links

• Getting Started
• Installation
• Quickstart
• Configuration
• Showcase

Getting Started in 5 Minutes

1. Install fr-docs: pip install fr-docs
2. Create config.json with project settings
3. Add markdown files to docs/src/
4. Build: fr-docs build
5. Deploy: Upload docs/site/ to your hosting provider

Features

• Config-driven: All settings defined in config.json
• Zero-config setup: Works out of the box with sensible defaults
• Search: Full-text search with Zstandard-compressed index
• Versioning: Semantic versioning from commit messages (4D - fix bug → 4.4.0)
• Optimized: HTML minification, critical CSS/JS inlining, Zstd compression
• Multi-environment: Different configs for production, staging, development
• Parallel builds: Threaded page generation for faster builds
• Git integration: Automatic metadata extraction from git commits
• Inline copy commands: Prefix inline code with c to create copy-on-click links: pip install fr-docs

Navigation

Getting Started

• Installation - Install fr-docs
• Quickstart - Step-by-step tutorial
• Configuration - Configure your project