startgit

Static page generator for git repositories

git clone git://git.dimitrijedobrota.com/startgit.git

README.md (1864B)

1 # startgit 2 3 Static page generator for git repositories 4 5 ## Description 6 7 With this project you can seamlessly turn a git repositories into a static 8 webpage, with auto generated indexes, diffs, commits and files for for each 9 branch. 10 11 The big source of inspiration for this project is [`Stagit`](https://codemadness.org/git/stagit/log.html). I've copied 12 most, if not all, of the functionality, with a few twists to fit my needs 13 better and fit with the reset of the aesthetic. 14 15 It's configured to make pages for my [`peronal projects`](https://git.dimitrijedobrota.com/), 16 but as generation code is self documenting , it can be easily adopted to fit 17 your needs. 18 19 As of now, md4c library is used to render markdown files in html for specific 20 pages in order to improve readability, until I find time to develop 21 sophisticated Markdown to HTML converter. 22 23 24 ## Dependencies 25 26 * CMake 3.14 or latter 27 * Compiler with C++20 support (tested: clang 18.1.8, gcc 14.2.1) 28 * [`Git2Wrap 0.1.0`](https://github.com/DimitrijeDobrota/gitwrap) 29 * [`Poafloc 1.0.0`](https://github.com/DimitrijeDobrota/poafloc) 30 * [`Hemplate 0,2,2`](https://github.com/DimitrijeDobrota/hemplate) 31 * [`md4c`](https://github.com/mity/md4c) 32 33 34 ## Building and installing 35 36 See the [`BUILDING`](BUILDING.md) document. 37 38 39 ## Usage 40 41 > Run `stargti --help` for the explanation of command line arguments 42 43 44 ## Version History 45 46 - 0.2 47 * Files, commits and diffs for each branch 48 * RSS and Atom feeds per branch 49 * On demand evaluation 50 * Github to local link translation 51 - 0.1 52 * Initial development phase 53 54 55 ## Contributing 56 57 See the [`CONTRIBUTING`](CONTRIBUTING.md) document. 58 59 60 # Licensing 61 62 This project is licensed under the MIT License 63 - see the [`LICENSE`](LICENSE.md) document for details 64 65 66 ## Acknowledgments 67 68 Inspiration, code snippets, etc. 69 * [`Stagit`](https://codemadness.org/git/stagit/log.html)