3lf/README Press
Build and verify release-ready PDF books from a Markdown README
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Aug 18, 2026
- License
- MIT
Pinned Snippet
uses: 3lf/readme-press@fa3d3ba5bfb5e2de41a0c3b4fbef290f2928fded # v0.2.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| command | One of build, qa, or pipeline | no | pipeline |
| config | Path to the README Press configuration, relative to the repository | yes | — |
| quality | Output edition for build or qa; pipeline builds every configured edition | no | all |
| release-version | Semantic release version such as v1.0.0 | no | "" |
| source-commit | Full source commit recorded in release metadata | no | "" |
| render-all | Render every PDF page during QA | no | true |
| install-pdf-tools | Install Poppler and qpdf when they are unavailable | no | true |
| working-directory | Consumer repository directory containing the config path | no | . |
Outputs
no outputs