Metadata-Version: 2.4
Name: docbuildr
Version: 1.0.6
Summary: Generate Markdown, HTML, and PDF books from online documentation.
Author-email: "Moss.kw" <k.pollapong@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/MossKW/docbuildr
Project-URL: Repository, https://github.com/MossKW/docbuildr
Project-URL: Issues, https://github.com/MossKW/docbuildr/issues
Project-URL: Documentation, https://github.com/MossKW/docbuildr
Keywords: documentation,markdown,pdf,html,playwright,static-site,book
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: playwright>=1.62
Requires-Dist: beautifulsoup4>=4.15
Requires-Dist: jinja2>=3.1
Requires-Dist: lxml>=6.1
Requires-Dist: markdown>=3.8
Requires-Dist: markdownify>=1.2
Requires-Dist: Pygments>=2.19
Requires-Dist: requests>=2.32
Provides-Extra: dev
Requires-Dist: pytest>=8.4; extra == "dev"
Requires-Dist: pytest-cov>=6.0; extra == "dev"
Dynamic: license-file

<p align="center">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/MossKW/docbuildr/main/assets/logo-dark.svg">
    <img src="https://raw.githubusercontent.com/MossKW/docbuildr/main/assets/logo-light.svg"
         alt="docbuildr"
         width="420">
  </picture>
</p>

<p align="center">
  <strong>Turn documentation websites into beautiful books.</strong>
</p>

<p align="center">
  Convert documentation websites into clean, offline-friendly <strong>Markdown</strong>,
  <strong>HTML</strong>, and <strong>PDF</strong> books with a single command.
</p>

<p align="center">

[![PyPI](https://img.shields.io/pypi/v/docbuildr.svg)](https://pypi.org/project/docbuildr/)
[![Python](https://img.shields.io/pypi/pyversions/docbuildr.svg)](https://pypi.org/project/docbuildr/)
[![License](https://img.shields.io/github/license/MossKW/docbuildr)](LICENSE)
[![Downloads](https://img.shields.io/pypi/dm/docbuildr)](https://pypi.org/project/docbuildr/)

</p>

---

# ✨ 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

```bash
pip install docbuildr
```

Install Chromium (required for PDF generation):

```bash
playwright install chromium
```

---

# 🚀 Quick Start

```bash
docbuildr https://gthlab.au/panaroo
```

Output:

```text
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:

```bash
git clone https://github.com/MossKW/docbuildr.git
cd docbuildr
```

Install development dependencies:

```bash
pip install -e ".[dev]"
```

Run tests:

```bash
pytest
```

Build package:

```bash
python -m build
```

---

# 🗺 Roadmap

- [x] Markdown export
- [x] HTML export
- [x] PDF export
- [x] HTML Viewer
- [x] Mermaid support
- [x] 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**

📧 k.pollapong@gmail.com
