Commit 53b8a05

Daniel Axtens <dja@axtens.net>
2026-10-29 01:11:30
Update readme
1 parent 2ccfad9
Changed files (1)
README.md
@@ -5,18 +5,22 @@
 Gitmal is a static page generator for Git repositories. Gitmal generates static HTML pages with files, commits,
 code highlighting, and markdown rendering.
 
+## This is a fork
+
+The upstream is <https://github.com/antonmedv/gitmal>.
+
+This version:
+ - clone: `git clone https://www.intermittent.network/git/gitmal.git`
+ - browse the [repository as rendered by the fork](https://www.intermittent.network/git/gitmal/)
+
 ## Installation
 
-```sh
-go install github.com/antonmedv/gitmal@latest
-```
+From a checkout:
 
 ```sh
-docker run --rm -v $(pwd):/repo antonmedv/gitmal /repo
+go install .
 ```
 
-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.
@@ -39,27 +43,18 @@ gitmal --help
   <a href="img/gitmal-screenshot-files.webp"><img src="img/gitmal-screenshot-files.webp" alt="Gitmal Files Page" width="400"></a>
 </p>
 
-## 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.
+Gitmal supports different code highlighting themes. Both a light and dark theme are required, and switching is based on the browser settings.
 
+The default is:
 ```sh
-gitmal --theme github-dark
+gitmal --light-theme github --dark-theme github-dark
 ```
 
 ## Documentation
 
+From upstream, not updated:
 - [How to Self-Host a Git Repository?](./docs/how-to-self-host-a-git-repository.md)
 
 ## License