summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md67
1 files changed, 0 insertions, 67 deletions
diff --git a/README.md b/README.md
deleted file mode 100644
index 6e76737..0000000
--- a/README.md
+++ /dev/null
@@ -1,67 +0,0 @@
-<p align="center"><img src="img/gitmal-color-logo.webp" alt="Gitmal" width="330" height="330"></p>
-
-# 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
-
-<p align="center">
- <a href="img/gitmal-screenshot-code-highlighting.webp"><img src="img/gitmal-screenshot-code-highlighting.webp" alt="Gitmal Code Highlighting" width="400"></a>
- <a href="img/gitmal-screenshot-file-tree.webp"><img src="img/gitmal-screenshot-file-tree.webp" alt="Gitmal File Tree" width="400"></a><br>
- <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.
-
-```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)