https://github.com/numtide/banner-generator
Nice banners for our repos
https://github.com/numtide/banner-generator
Last synced: 5 months ago
JSON representation
Nice banners for our repos
- Host: GitHub
- URL: https://github.com/numtide/banner-generator
- Owner: numtide
- License: mit
- Created: 2025-07-28T19:35:28.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-29T09:42:49.000Z (11 months ago)
- Last Synced: 2025-07-29T11:36:58.293Z (11 months ago)
- Language: Mustache
- Homepage: https://banner.numtide.com/
- Size: 5.57 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Generates SVG and PNG banners for Numtide's GitHub repositories with automatic metadata fetching.
## Quick Start
### Embed in Your README
Add this to any Numtide repository README:
```markdown
```
## Usage
```bash
nix run github:numtide/banner-generator#banner-api
nix run github:numtide/banner-generator#banner-cli
```
## API Endpoints
- `GET /banner/{owner}/{repo}.svg` - Generate SVG banner
- `GET /banner/{owner}/{repo}.png` - Generate PNG banner
## CLI Usage
```bash
# Generate PNG
banner-cli generate owner/repo -o banner.png
# Generate and upload to GitHub
banner-cli generate-upload owner/repo --token $GITHUB_TOKEN
```
## Configuration
See `deploy/banner-generator.toml` for configuration options.
## Template Structure
Templates are pure SVG files with specific element IDs that get replaced dynamically:
| Element ID | Description | Example Content |
|------------|-------------|-----------------|
| `repo-name` | Repository name text | "banner-generator" |
| `description` | Description text (can contain tspan elements) | "Generate banners..." |
| `stats-stars` | Stars count text | "⭐ 1.2k" |
| `stats-forks` | Forks count text | "🍴 45" |
| `stats-language` | Primary language text | "Go" |
| `stats-group` | Stats container (hidden if no data) | - |
| `font-css` | Style element for font injection | - |
## Development
```bash
nix develop
make dev # Run with hot reload
make build # Build binaries
make test # Run tests
make lint # Run linters
```
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
## License
MIT