-rw-r--r-- README.rst
1 gitja 2 ===== 3 4 .. image:: https://img.shields.io/github/v/release/m-col/gitja?color=904ff0 5 :alt: GitHub release (latest SemVer) 6 7 8 ``gitja`` generates pretty web pages from your git repositories using custom 9 Jinja_\* HTML templates. 10 11 ``gitja`` complements your static site generator so that you can display your 12 code however you want, in a style consistent with the rest of your website! 13 14 This was inspired by stagit_, which generates content with a hard-coded style, 15 so if you like that style and don't want to edit templates, you may prefer to 16 use that. 17 18 \*The templating engine is not Jinja per se, but ginger_, an implementation of 19 the Jinja language for Haskell. Please see their docs for any differences. 20 21 Getting Started 22 --------------- 23 24 Currently installation is only possible via source:: 25 26 git clone https://github.com/m-col/gitja 27 cd gitja 28 stack install 29 30 Documentation and a preview of the kind of pages ``gitja`` can generate is 31 available here_. 32 33 If you like skipping the manual, running ``gitja --template`` will create a 34 base template and config in the current folder from which you can create your 35 own. 36 37 Contributing 38 ------------ 39 40 If you've come across a bug or have a question feel free to `open an issue`_. 41 Pull requests are also warmly welcome if you have any suggested improvements or 42 fixes. Please format code with fourmolu_'s defaults, use hlint_, and make sure 43 ``test/test.sh`` is happy. 44 45 Meta 46 ---- 47 48 Development hosted @ https://github.com/m-col/gitja. Written by Matt 49 Colligan and `licensed MIT <LICENSE>`_. 50 51 .. _Jinja: https://jinja.palletsprojects.com 52 .. _stagit: https://codemadness.org/git/stagit 53 .. _ginger: https://ginger.tobiasdammers.nl 54 .. _`open an issue`: https://github.com/m-col/gitja/issues/new 55 .. _fourmolu: https://github.com/fourmolu/fourmolu 56 .. _hlint: https://github.com/ndmitchell/hlint 57 .. _here: https://gitja.mcol.xyz 58