Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benjif/gitgen
Static webpage generator for Git
https://github.com/benjif/gitgen
git html-generator
Last synced: 14 days ago
JSON representation
Static webpage generator for Git
- Host: GitHub
- URL: https://github.com/benjif/gitgen
- Owner: benjif
- License: mit
- Created: 2020-12-25T02:04:08.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-22T22:29:35.000Z (over 3 years ago)
- Last Synced: 2024-12-15T15:57:42.791Z (19 days ago)
- Topics: git, html-generator
- Language: C++
- Homepage: https://git.frady.org/gitgen/
- Size: 1.05 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gitgen - static webpage generator for git
## Installation
```
# For optional syntax highlighting
GG_COLOR=TRUE
sudo make install-color
# For optional markdown rendering
GG_MARKDOWN=TRUE
make && sudo make install
```
## Usage
### Generate files for a repository
```bash
# This will put everything into public/
./gitgen repo [--max-commits ] [--max-filesize ] [--max-diff-lines ]
```
### Generate an index file
```bash
./gitgen index ...
```
## Syntax Highlighting and Markdown Rendering
Syntax highlighting requires [GNU source-highlight](https://www.gnu.org/software/src-highlite/) and markdown rendering requires [md4c](https://github.com/mity/md4c). Note that syntax highlighting currently slows generation by around ~2x.
## Dependencies
* [libgit2](https://libgit2.org/)
* [libsource-highlight](https://www.gnu.org/software/src-highlite/) (optional, for highlighting)
* [md4c](https://github.com/mity/md4c) (optional, for markdown rendering)
## Other Projects
* [stagit](https://codemadness.org/stagit.html) is another static page generator for git.
* [cgit](https://git.zx2c4.com/cgit/about/) is a CGI web interface for git.