gitmal

Gitmal

Gitmal is a static page generator for Git repositories. Gitmal generates static HTML pages with files, commits, code highlighting, and markdown rendering.

Installation

go install github.com/antonmedv/gitmal@latest

docker run --rm -v $(pwd):/repo antonmedv/gitmal /repo

Or download prebuilt binary from releases.

Usage

Run gitmal in the repository dir. Gitmal will generate pages in ./output directory.

gitmal .

Run gitmal with --help flag, go get a list of available options.

gitmal --help

Screenshots

Examples

Here are a few examples of repos hosted on my website:

• git.medv.io/zx/ — github.com/google/zx
• git.medv.io/zig/ — codeberg.org/ziglang/zig (light theme)
• git.medv.io/my-badges/ — github.com/my-badges/my-badges

Gitmal on kubernetes repository works as well. Generation on my MacBook Air M2 with --minify and --gzip flags takes around 25 minutes, and the generated files weigh around 2 GB.

Themes

Gitmal supports different code highlighting themes. You can customize the theme with --theme flag.

gitmal --theme github-dark

Documentation

• How to Self-Host a Git Repository?

License

MIT