2 > static git page generator.
4 Personal fork with fast syntax highlighting via Chroma, markdown rendering, and some other style and quality of life improvements.
6 It generates static HTML pages for a Git repository.
9 Make files per repository:
12 $ mkdir -p htmldir && cd htmldir
16 Make index file for repositories:
19 $ stagit-index repodir1 repodir2 repodir3
31 - libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl).
35 - POSIX make (optional).
38 See man pages: stagit(1) and stagit-index(1).
41 - Log of all commits from HEAD.
42 - Log and diffstat per commit.
43 - Show file tree with linkable line numbers.
44 - Show references: local branches and tags.
45 - Detect README and LICENSE file from HEAD and link it as a webpage.
46 - Detect submodules (.gitmodules file) from HEAD and link it as a webpage.
47 - Atom feed log (atom.xml).
48 - Make index page for multiple repositories with stagit-index.
49 - After generating the pages (relatively slow) serving the files is very fast, simple and requires little resources (because the content is static), only a HTTP file server is required.
50 - Usable with text-browsers such as dillo, links, lynx and w3m.
51 - Render Markdown files to HTML.
52 - Syntax highlighting.
55 ### Large repositories
56 - Not suitable for large repositories (2000+ commits), because diffstats are an expensive operation, the cache (-c flag) is a workaround for this in some cases.
57 - Not suitable for large repositories with many files, because all files are written for each execution of stagit. This is because stagit shows the lines of textfiles and there is no "cache" for file metadata (this would add more complexity to the code).
58 - Not suitable for repositories with many branches, a quite linear history is assumed (from HEAD).
60 In these cases it is better to just use cgit or possibly change stagit to run as a CGI program.
62 ### Not as featureful as cgit
63 - Does not support some of the dynamic features cgit has, like: Snapshot tarballs per commit.
64 - File tree per commit.
65 - History log of branches diverged from HEAD.
66 - Stats (git shortlog -s).
68 This is by design, just use Git locally.
71 stagit is licensed under the MIT/X Consortium License, please refer to the "LICENSE" file for more information.