collectioneur/readme-aura
Next-Gen README generator - render React/JSX components to beautiful SVG inside Markdown
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| source | Path to the source markdown file | no | readme.source.md |
| output | Path to the generated README file | no | README.md |
| assets_dir | Directory to store generated SVG/image assets | no | .github/assets |
| github_token | GitHub token for fetching user/repo stats (defaults to GITHUB_TOKEN) | no | ${{ github.token }} |
| github_user | GitHub username (auto-detected from repo owner if omitted) | no | "" |
| fonts_dir | Path to directory with custom font files (.ttf/.otf/.woff) | no | "" |
| commit_message | Commit message for the auto-commit | no | regenerate README via readme-aura |
| auto_commit | Whether to auto-commit and push generated files | no | true |
Outputs
| name | description |
|---|---|
| changed | Whether the README was changed (true/false) |