Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/m-col/gitja

Templated web page generator for your git repositories 🐙
https://github.com/m-col/gitja

git haskell jinja2 self-hosted static-site static-site-generator

Last synced: 20 days ago
JSON representation

Templated web page generator for your git repositories 🐙

Awesome Lists containing this project

README

        

gitja
=====

.. image:: https://img.shields.io/github/v/release/m-col/gitja?color=904ff0
:alt: GitHub release (latest SemVer)

``gitja`` generates pretty web pages from your git repositories using custom
Jinja_\* HTML templates.

``gitja`` complements your static site generator so that you can display your
code however you want, in a style consistent with the rest of your website!

This was inspired by stagit_, which generates content with a hard-coded style,
so if you like that style and don't want to edit templates, you may prefer to
use that.

\*The templating engine is not Jinja per se, but ginger_, an implementation of
the Jinja language for Haskell. Please see their docs for any differences.

Getting Started
---------------

Currently installation is only possible via source::

git clone https://github.com/m-col/gitja
cd gitja
stack install

Documentation and a preview of the kind of pages ``gitja`` can generate is
available here_.

If you like skipping the manual, running ``gitja --template`` will create a
base template and config in the current folder from which you can create your
own.

Contributing
------------

If you've come across a bug or have a question feel free to `open an issue`_.
Pull requests are also warmly welcome if you have any suggested improvements or
fixes. Please format code with fourmolu_'s defaults, use hlint_, and make sure
``test/test.sh`` is happy.

Meta
----

Development hosted @ https://github.com/m-col/gitja. Written by Matt
Colligan and `licensed MIT `_.

.. _Jinja: https://jinja.palletsprojects.com
.. _stagit: https://codemadness.org/git/stagit
.. _ginger: https://ginger.tobiasdammers.nl
.. _`open an issue`: https://github.com/m-col/gitja/issues/new
.. _fourmolu: https://github.com/fourmolu/fourmolu
.. _hlint: https://github.com/ndmitchell/hlint
.. _here: https://gitja.mcol.xyz