barttc/Render README, CHANGELOG, etc. on GitHub Pages
Zero-config docs. Transform README, CHANGELOG, etc. into beautiful single-page HTML documentation.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| files | Markdown files to process (one per line or space-separated) | yes | — |
| title | Documentation title (defaults to first H1 in first file) | no | "" |
| output | Output HTML file path | no | index.html |
| template | Path to custom HTML template file | no | "" |
| repo-url | Repository URL to include in documentation | no | "" |
| deploy | Whether to automatically deploy to GitHub Pages (requires pages permissions) | no | true |
| artifact-dir | Directory to prepare for deployment (used when deploy is true) | no | dist |
Outputs
| name | description |
|---|---|
| output-file | Path to the generated HTML file |
| page_url | URL of the deployed GitHub Pages site |