Turn documentation websites into beautiful books.
Convert documentation websites into clean, offline-friendly Markdown, HTML, and PDF books with a single command.
✨ Features
| Feature | Status |
|---|---|
| Crawl documentation websites | ✅ |
| Merge multiple pages into one book | ✅ |
| Export Markdown | ✅ |
| Export standalone HTML | ✅ |
| Export print-ready PDF | ✅ |
| Interactive HTML Viewer | ✅ |
| Automatic Table of Contents | ✅ |
| Syntax Highlighting | ✅ |
| Offline KaTeX Rendering | ✅ |
| Mermaid Diagrams | ✅ |
| Smart Table Formatting | ✅ |
| Automatic Image Download | ✅ |
📦 Installation
pip install docbuildr
Install Chromium (required for PDF generation):
playwright install chromium
🚀 Quick Start
docbuildr https://gthlab.au/panaroo
Output:
output/
├── book.md
├── book.html
├── viewer.html
└── book.pdf
📚 Supported Content
- Markdown
- Tables
- Images
- Code blocks
- Mermaid diagrams
- KaTeX equations
- Nested headings
- Internal links
🛠 Development
Clone the repository:
git clone https://github.com/MossKW/docbuildr.git
cd docbuildr
Install development dependencies:
pip install -e ".[dev]"
Run tests:
pytest
Build package:
python -m build
🗺 Roadmap
- Markdown export
- HTML export
- PDF export
- HTML Viewer
- Mermaid support
- KaTeX support
- EPUB export
- Search index
- Theme engine
- Plugin system
🤝 Contributing
Contributions are welcome!
Please read CONTRIBUTING.md before submitting a pull request.
📄 License
Released under the MIT License.
👤 Author
Developed by Moss.kw
1 maintainer
Metadata
1 maintainer
Release files for docbuildr 1.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| docbuildr-1.0.5.tar.gz | 2.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| docbuildr-1.0.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.7 MB
Release files / docbuildr-1.0.5.tar.gz
| Download URL | docbuildr-1.0.5.tar.gz |
|---|---|
| Size | 2.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
927bcbd307d5a2b883f2610bce9a9a752bab20a692eab3b085185a5981660dd5
|
|
BLAKE2b-256 checksum How to use checksums |
833b20cfc15081fa5ca4f32bead9bafeb0eba5e67482faaa2f200dd6b3e41141
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.8
|
Release files / docbuildr-1.0.5-py3-none-any.whl
| Download URL | docbuildr-1.0.5-py3-none-any.whl |
|---|---|
| Size | 2.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
80c131f88b7351390d0fda8d3d7311f90234fc4620259d5405cbe91b56597c0f
|
|
BLAKE2b-256 checksum How to use checksums |
7482de5fc8c75ff31e0838381ad91dda7a78cb2bd5d326178ab89591b65911ec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.8
|
