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 | ✅ |
| Markdown export | ✅ |
| HTML export | ✅ |
| Print-ready PDF export | ✅ |
| Interactive HTML Viewer | ✅ |
| Automatic table of contents | ✅ |
| Syntax-highlighted code blocks | ✅ |
| Mermaid diagrams | ✅ |
| Offline KaTeX rendering | ✅ |
| Automatic image downloading | ✅ |
| Unit-tested core components | ✅ |
📦 Installation
pip install docbuildr
playwright install chromium
🚀 Quick Start
docbuildr https://gthlab.au/panaroo
Generated 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
💡 Why docbuildr?
Instead of manually saving web pages or printing documentation to PDF, docbuildr automatically:
- 📖 Crawls an entire documentation website
- 📚 Merges every page into a single book
- 📑 Generates a clean table of contents
- 🎨 Preserves syntax highlighting
- 📄 Produces beautiful print-ready PDF
- 🌐 Creates standalone HTML for offline reading
🛠 Development
git clone https://github.com/MossKW/docbuildr.git
cd docbuildr
pip install -e ".[dev]"
python -m pytest
python -m build
🗺 Roadmap
| Feature | Status |
|---|---|
| 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 opening an issue or submitting a pull request.
📄 License
Released under the MIT License.
See LICENSE for details.
👨💻 Author
Developed by Moss.kw
GitHub: https://github.com/MossKW
1 maintainer
Metadata
1 maintainer
Release files for docbuildr 1.0.4
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.4.tar.gz | 2.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| docbuildr-1.0.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 4.7 MB
Release files / docbuildr-1.0.4.tar.gz
| Download URL | docbuildr-1.0.4.tar.gz |
|---|---|
| Size | 2.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
03294903cdf4ab00a95084f6ab0097592303b5a20ea5d6d92ff2b5cb5014a038
|
|
BLAKE2b-256 checksum How to use checksums |
00bb8da0f4fdab0c7b23e04ed59404e54baa1252b2154e42bef6fce96b1e8b48
|
| 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.4-py3-none-any.whl
| Download URL | docbuildr-1.0.4-py3-none-any.whl |
|---|---|
| Size | 2.3 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ace56ea1153ec27f47b2585828d2cd94cb3c0a627d577386c2fa6f2c1086a7bb
|
|
BLAKE2b-256 checksum How to use checksums |
3a243414780bcd5bb3b794fd5ff391edfbe224634ade922dbf39810bcc0a1d69
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.8
|
