Absortio

Email → Summary → Bookmark → Email

GitHub - antonmedv/gitmal: A static page generator for repos

Extracto

A static page generator for repos. Contribute to antonmedv/gitmal development by creating an account on GitHub.

Resumen

Resumen Principal

Gitmal emerge como una solución altamente especializada y eficiente para la generación de páginas estáticas a partir de repositorios Git. Su función principal es transformar el contenido de un repositorio, incluyendo archivos, historial de commits, y código, en un formato HTML accesible y navegable directamente desde un navegador web. Esto lo convierte en una herramienta invaluable para desarrolladores, proyectos de código abierto y organizaciones que buscan auto-alojar o presentar sus bases de código de manera clara y profesional sin la complejidad de servidores dinámicos. Gitmal no solo ofrece una representación fiel del repositorio, sino que también integra resaltado de código y renderizado de markdown, mejorando significativamente la legibilidad y la experiencia de usuario. La mención de su rendimiento al procesar 2 GB de archivos en aproximadamente 25 minutos en un MacBook Air M2, incluso con opciones de minificación y compresión GZIP, subraya su capacidad para manejar proyectos de gran escala, incluyendo aquellos gestionados en entornos como Kubernetes. Su flexibilidad en la

Contenido

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.

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

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

Fuente: GitHub