Metadata-Version: 2.4
Name: docbuildr
Version: 1.0.2
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

# DocBuildr

> Build beautiful PDF books from online documentation.

DocBuildr is a command-line tool that crawls documentation websites,
merges pages into a single book, and generates professional-quality
Markdown, HTML, and PDF outputs.

Designed for developers, researchers, engineers, and scientists who want
offline documentation with clean typography, mathematical rendering, and
print-friendly layouts.

------------------------------------------------------------------------

## Features

-   📖 Crawl documentation websites automatically
-   📚 Merge multiple pages into a single book
-   📝 Generate clean Markdown output
-   🌐 Export standalone HTML
-   📄 Export print-ready PDF
-   🎨 Professional book layout
-   🖼 Responsive images
-   📊 Smart table formatting
-   💻 Optimized code blocks
-   📑 Automatic table of contents
-   ➗ Offline KaTeX math rendering
-   ✅ Syntax highlighting
-   ✅ Unit-tested core components
-   🔄 GitHub Actions continuous integration
-   ⚡ Simple command-line interface

------------------------------------------------------------------------

## Installation

Install from PyPI

``` bash
pip install docbuildr
```

Install Chromium

``` bash
playwright install chromium
```

Or install the latest development version

``` bash
git clone https://github.com/MossKW/docbuildr.git
cd docbuildr
pip install -e ".[dev]"
```

------------------------------------------------------------------------

## Requirements

-   Python 3.11+
-   Playwright
-   Chromium browser

------------------------------------------------------------------------

## Quick Start

``` bash
docbuildr https://gthlab.au/panaroo --title "Panaroo User Guide"
```

Produces

``` text
output/
├── book.md
├── book.html
├── book.pdf
└── viewer.html
```

------------------------------------------------------------------------

## Current Features

  Feature                    Status
  ------------------------- --------
  Documentation crawler        ✅
  Markdown export              ✅
  HTML export                  ✅
  PDF export                   ✅
  Table of contents            ✅
  Cover page                   ✅
  Smart tables                 ✅
  Print layout                 ✅
  Viewer                       ✅
  Professional CLI             ✅
  Offline KaTeX rendering      ✅
  Syntax highlighting          ✅
  Unit tests                   ✅
  GitHub Actions CI            ✅
  Theme engine                 🚧
  EPUB export                  🚧
  Search index                 🚧
  Plugin system                🚧

------------------------------------------------------------------------

## Roadmap

### Upcoming

-   Theme engine
-   EPUB export
-   Search index
-   Plugin system

------------------------------------------------------------------------

## Development

``` bash
pip install -e ".[dev]"
python -m compileall src
python -m pytest
python -m pytest --cov=docbuildr
```

------------------------------------------------------------------------

## Contributing

Contributions are welcome.

Please read **CONTRIBUTING.md** before submitting a pull request.

------------------------------------------------------------------------

## License

MIT License

------------------------------------------------------------------------

## Author

Developed by **Moss.kw**

Built with Python, Playwright, and modern web technologies.
