startgit

Static page generator for git repositories

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

README.md (1957B)

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