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 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 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:
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, including roleplaying scenarios and workplace accessibility documents. Template selection is not available yet.
1 maintainer
Metadata
1 maintainer
Release files for chaptr 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| chaptr-0.1.1.tar.gz | 26.3 kB | With provenance | Details for chaptr-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| chaptr-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for chaptr-0.1.1-py3-none-any.whl |
Total release size: 53.1 kB
Release files / chaptr-0.1.1.tar.gz
| Download URL | chaptr-0.1.1.tar.gz |
|---|---|
| Size | 26.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
026cea39aafafcdecc272684299da45e5932f7abf1da9e982e3da2bb3ed26e6b
|
|
BLAKE2b-256 checksum How to use checksums |
fc152e21a684ae8abc53f6b55145092ccf7c44eabfc91a176cb2f4b2ecc5e836
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.
Transparency logRelease files / chaptr-0.1.1-py3-none-any.whl
| Download URL | chaptr-0.1.1-py3-none-any.whl |
|---|---|
| Size | 26.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
51115973fd77812a6016ae94c87cbadc3d0769803f2c5e3a07f68270b7f717d0
|
|
BLAKE2b-256 checksum How to use checksums |
5c608f061ed68dc62600401916ecd535485842ba1fd63aadeed588f319d3d840
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.
Transparency logSecurity for chaptr 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for chaptr-0.1.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
