https://github.com/antonmedv/gitmal
A static page generator for repos
https://github.com/antonmedv/gitmal
git go static-site-generator
Last synced: 1 day ago
JSON representation
A static page generator for repos
- Host: GitHub
- URL: https://github.com/antonmedv/gitmal
- Owner: antonmedv
- License: mit
- Created: 2025-11-30T16:18:24.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2025-12-25T22:17:33.000Z (20 days ago)
- Last Synced: 2025-12-27T08:49:19.245Z (19 days ago)
- Topics: git, go, static-site-generator
- Language: Go
- Homepage:
- Size: 660 KB
- Stars: 1,108
- Watchers: 8
- Forks: 40
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - antonmedv/gitmal - A static page generator for repos (Go)
README
# Gitmal
Gitmal is a static page generator for Git repositories. Gitmal generates static HTML pages with files, commits,
code highlighting, and markdown rendering.
## Installation
```sh
go install github.com/antonmedv/gitmal@latest
```
```sh
docker run --rm -v $(pwd):/repo antonmedv/gitmal /repo
```
Or download prebuilt binary from [releases](https://github.com/antonmedv/gitmal/releases).
## Usage
Run gitmal in the repository dir. Gitmal will generate pages in _./output_ directory.
```sh
gitmal .
```
Run gitmal with `--help` flag, go get a list of available options.
```sh
gitmal --help
```
## Screenshots
## Examples
Here are a few examples of repos hosted on my website:
- [git.medv.io/zx/](https://git.medv.io/zx/) — github.com/google/zx
- [git.medv.io/zig/](https://git.medv.io/zig/) — codeberg.org/ziglang/zig (light theme)
- [git.medv.io/my-badges/](https://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.
```sh
gitmal --theme github-dark
```
## Documentation
- [How to Self-Host a Git Repository?](./docs/how-to-self-host-a-git-repository.md)
## License
[MIT](LICENSE)