Metadata-Version: 2.4
Name: chaptr
Version: 0.1.1
Summary: Build independent Markdown document projects with shared variables and CSS themes.
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: markdown-it-py<5,>=3
Requires-Dist: mdit-py-plugins<1,>=0.5
Requires-Dist: PyYAML<7,>=6
Provides-Extra: pdf
Requires-Dist: WeasyPrint<70,>=68; extra == "pdf"
Requires-Dist: pypdf<7,>=6; extra == "pdf"
Provides-Extra: dev
Requires-Dist: pytest<10,>=8; extra == "dev"
Requires-Dist: pypdf<7,>=6; extra == "dev"

# chaptr

Turn separate Markdown chapters into one document, with shared variables and
editable themes. Produce merged Markdown, styled HTML or PDF.

## Usage

chaptr runs in your terminal. Install it once and use it across document projects.
See [installation instructions](docs/01-requirements.md#installation) for the
source checkout and GitHub release wheel options.

| Command | Purpose |
| --- | --- |
| `chaptr init [directory]` | Create an editable copy of the app's documentation |
| `chaptr build` | Build the current project; HTML is the default |
| `chaptr build --format pdf` | Generate PDF when renderer dependencies are available |
| `chaptr help` | Read the bundled command manual |
| `chaptr --help` | List commands; each command also supports `--help` |

See the [documentation](docs/README.md) for requirements, the user workflow,
configuration, themes and current limitations. The documentation is itself an
chaptr project, so you can try the tool on its own source:

```sh
chaptr build --config docs/document.yaml
```

## Changelog

### 0.1.1 - Unreleased

- Renamed the package and command to chaptr.
- Added publishing to PyPI through GitHub Actions Trusted Publishing.

### 0.1.0

- Project initialization with the app's documentation and overwrite protection.
- Ordered Markdown chapters and simple shared variables.
- Automatic table captions, linked footnotes and a table of contents.
- Optional title pages, covers and author sections.
- Pre-designed PDF covers with page-size validation and preserved contents links.
- Markdown and HTML output, with an optional WeasyPrint PDF renderer.
- Bundled themes, project-local overrides and additional stylesheets.
- Command help and a bundled usage manual.

PDF requires native libraries.

Planned: [named document templates](docs/07-roadmap.md), including roleplaying
scenarios and workplace accessibility documents. Template selection is not available yet.
