startgit

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 [`personal 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

28

29 ## Building and installing

30

31 See the [`BUILDING`](BUILDING.md) document.

32

33

34 ## Usage

35

36 > Run `stargti --help` for the explanation of command line arguments

37

38

39 ## Version History

40

41 * 0.3

42 * Modernize the codebase using new hemplate

43 * 0.2.1

44 * Remove branch dropdown

45 * Handle only one repository

46 * Separate indexer

47 * 0.2

48 * Files, commits and diffs for each branch

49 * RSS and Atom feeds per branch

50 * On demand evaluation

51 * Github to local link translation

52 * 0.1

53 * Initial development phase

54

55

56 ## Contributing

57

58 See the [`CONTRIBUTING`](CONTRIBUTING.md) document.

59

60

61 # Licensing

62

63 This project is licensed under the MIT License

64 - see the [`LICENSE`](LICENSE.md) document for details

65

66

67 ## Acknowledgments

68

69 Inspiration, code snippets, etc.

70 * [`Stagit`](https://codemadness.org/git/stagit/log.html)