benjif / gitgen

Static webpage generator for Git

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

# This will put everything into public/
./gitgen repo <repo path> [--max-commits <max>] [--max-filesize <max>] [--max-diff-lines <max>]

Generate an index file

./gitgen index <repo path>...

Syntax Highlighting and Markdown Rendering

Syntax highlighting requires GNU source-highlight and markdown rendering requires md4c. Note that syntax highlighting currently slows generation by around ~2x.

Dependencies

• libgit2
• libsource-highlight (optional, for highlighting)
• md4c (optional, for markdown rendering)

Other Projects

• stagit is another static page generator for git.
• cgit is a CGI web interface for git.