gistatic

Static Git repository generator

Generate HTML pages for a Git repository. The generated pages are static and offline-first, and can be made available online as static assets.

Usage

Generate static HTML website for Git repository:

$ gistatic path/to/git/ -o public/

Installation

Get the latest tarball and install it:

wget https://euandreh.xyz/gistatic/tarballs/gistatic-main.tar.gz
tar xvf gistatic-main.tar.gz
cd gistatic-main/
make
[sudo] make install

The requirements are Perl with dependencies: - Git::Raw: Perl bindings to libgit2; - Mustache::Simple: template library for generating output files; - CommonMark: CommonMark renderer.

Documentation

Documentation available via installed manpages, also available online: gistatic.1 and gistatic-template.5.

Contributing

Extra tools used for development are: - Perl::Critic and B::Lint for linting; - perltidy for code formatting; - ShellCheck for validating scripts; - pandoc for generating the documentation HTML and website.

For running the extra development-only checks, run:

$ make dev-check

and for generating the documentation HTML and website, run:

$ make public

For running the extra development-only checks, run:

$ make dev-check

and for generating the documentation HTML and website, run:

$ make public

Send contributions to the mailing list via git send-email.

Links

License

The code is licensed under GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later).