Metadata-Version: 2.4
Name: pookiedocs
Version: 0.1.1
Summary: A minimal Python documentation site generator. Markdown and HTML to static site with live reload.
Author: Grace Peter Mutiibwa
License: MIT
Project-URL: Homepage, https://github.com/GracePeterMutiibwa/pookiedocs
Project-URL: Repository, https://github.com/GracePeterMutiibwa/pookiedocs
Project-URL: Documentation, https://pookiedocs.readthedocs.io
Keywords: documentation,static site,markdown,generator,docs
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: mistune>=3.0
Requires-Dist: Jinja2>=3.1
Requires-Dist: click>=8.1
Requires-Dist: watchdog>=4.0
Requires-Dist: livereload>=2.7
Requires-Dist: PyYAML>=6.0
Provides-Extra: dev
Requires-Dist: pytest>=7.4; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: ruff; extra == "dev"

# pookiedocs

[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://python.org)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Documentation Status](https://readthedocs.org/projects/pookiedocs/badge/?version=latest)](https://pookiedocs.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://img.shields.io/pypi/v/pookiedocs.svg)](https://pypi.org/project/pookiedocs/)

A minimal Python documentation site generator. Reads markdown and HTML files from a folder, converts them to a clean static site, and serves them — in development with live reload, in production with a built-in HTTP server.

## Installation

```bash
pip install pookiedocs
```

## Quick start

```bash
pookiedocs init
pookiedocs dev
```

`pookiedocs dev` starts a live-reload server at `http://localhost:3000`. Edit any file and the browser refreshes automatically.

## Production

```bash
pookiedocs serve
```

Builds the site and serves it on `0.0.0.0:3000`. No separate web server needed — drop this command into a Dockerfile and you're done.

## Build only

```bash
pookiedocs build
```

Writes a fully self-contained static site to `dist/`. Deploy by pointing any static file host at that folder.

## Deployment

**Docker** - the simplest path to production:

```dockerfile
FROM python:3.12-slim
WORKDIR /app
COPY . .
RUN pip install --no-cache-dir pookiedocs
EXPOSE 3000
CMD ["pookiedocs", "serve", "--port", "3000"]
```

```bash
docker build -t my-docs .
docker run -p 3000:3000 my-docs
```

Deploy the image to GCP Cloud Run, AWS App Runner, Fly.io, Railway, or any container platform.

**Cloudflare Pages** - set the build command to `pip install pookiedocs && pookiedocs build` and the output directory to `dist`.

**Netlify** - add a `netlify.toml`:

```toml
[build]
  command = "pip install pookiedocs && pookiedocs build"
  publish = "dist"
```

**GitHub Pages** - add a workflow that runs `pookiedocs build --output _site` and uploads the `_site` artifact with `actions/upload-pages-artifact`.

**VPS** - build locally, `rsync` the `dist/` folder to your server, and serve it with nginx:

```nginx
server {
    listen 80;
    server_name docs.example.com;
    root /var/www/docs;
    index index.html;

    location / {
        try_files $uri $uri/ $uri.html =404;
    }
}
```

See the [Deployment guide](https://pookiedocs.readthedocs.io/en/latest/deployment/) for full examples including the complete GitHub Actions workflow and HTTPS setup with Certbot.

## Documentation

Full documentation is available at https://pookiedocs.readthedocs.io

## License

MIT
