Home
Softono

Gitmal

Open source MIT Go
1.3K
Stars
48
Forks
16
Issues
10
Watchers
7 months
Last Commit

 About Gitmal

A static page generator for repos

Platforms

Web Self-hosted

Languages

Go

Links

Need Help Installing Gitmal?

We provide expert installation service for this software. Our team will install, configure, and secure Gitmal on your server. plans start at just $30.

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

Gitmal Code Highlighting Gitmal File Tree
Gitmal Files Page

Examples

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

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

License

MIT