stagit - www.codemadness.org - www.codemadness.org saait content files
HTML git clone git://git.codemadness.org/www.codemadness.org
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
stagit (4704B)
---
1 1<- Back / codemadness.org 70
2 i codemadness.org 70
3 i codemadness.org 70
4 i# Stagit: a static git page generator codemadness.org 70
5 i codemadness.org 70
6 iLast modification on 2021-04-11 codemadness.org 70
7 i codemadness.org 70
8 istagit is a static page generator for git. codemadness.org 70
9 i codemadness.org 70
10 1Read the README for more information about it. /git/stagit/file/README.gph codemadness.org 70
11 i codemadness.org 70
12 iMy git repository uses stagit, you can see how it looks here: codemadness.org 70
13 hhttps://codemadness.org/git/ URL:https://codemadness.org/git/ codemadness.org 70
14 i codemadness.org 70
15 i codemadness.org 70
16 i## Features codemadness.org 70
17 i codemadness.org 70
18 i* Log of all commits from HEAD. codemadness.org 70
19 i* Log and diffstat per commit. codemadness.org 70
20 i* Show file tree with linkable line numbers. codemadness.org 70
21 i* Show references: local branches and tags. codemadness.org 70
22 i* Detect README and LICENSE file from HEAD and link it as a webpage. codemadness.org 70
23 i* Detect submodules (.gitmodules file) from HEAD and link it as a webpage. codemadness.org 70
24 i* Atom feed of the commit log (atom.xml). codemadness.org 70
25 i* Atom feed of the tags/refs (tags.xml). codemadness.org 70
26 i* Make index page for multiple repositories with stagit-index. codemadness.org 70
27 i* After generating the pages (relatively slow) serving the files is very fast, codemadness.org 70
28 i simple and requires little resources (because the content is static), only codemadness.org 70
29 i a HTTP file server is required. codemadness.org 70
30 i* Security: all pages are static. No CGI or dynamic code is run for the codemadness.org 70
31 i interface. Using it with a secure httpd such as OpenBSD httpd it is codemadness.org 70
32 i privilege-separated, chroot(2)'d and pledge(2)'d. codemadness.org 70
33 i* Simple to setup: the content generation is clearly separated from serving codemadness.org 70
34 i it. This makes configuration as simple as copying a few directories and codemadness.org 70
35 i scripts. codemadness.org 70
36 i* Usable with text-browsers such as dillo, links, lynx and w3m. codemadness.org 70
37 i codemadness.org 70
38 i codemadness.org 70
39 i## Cons codemadness.org 70
40 i codemadness.org 70
41 i* Not suitable for large repositories (2000+ commits), because diffstats are codemadness.org 70
42 i an expensive operation, the cache (-c flag) or (-l maxlimit) is a workaround codemadness.org 70
43 i for this in some cases. codemadness.org 70
44 i* Not suitable for large repositories with many files, because all files are codemadness.org 70
45 i written for each execution of stagit. This is because stagit shows the lines codemadness.org 70
46 i of textfiles and there is no "cache" for file metadata (this would add more codemadness.org 70
47 i complexity to the code). codemadness.org 70
48 i* Not suitable for repositories with many branches, a quite linear history is codemadness.org 70
49 i assumed (from HEAD). codemadness.org 70
50 i codemadness.org 70
51 hIn these cases it is better to use »cgit« or URL:https://git.zx2c4.com/cgit/ codemadness.org 70
52 ipossibly change stagit to run as a CGI program. codemadness.org 70
53 i codemadness.org 70
54 i* Relatively slow to run the first time (about 3 seconds for sbase, codemadness.org 70
55 i 1500+ commits), incremental updates are faster. codemadness.org 70
56 i* Does not support some of the dynamic features cgit has, like: codemadness.org 70
57 i * Snapshot tarballs per commit. codemadness.org 70
58 i * File tree per commit. codemadness.org 70
59 i * History log of branches diverged from HEAD. codemadness.org 70
60 i * Stats (git shortlog -s). codemadness.org 70
61 i codemadness.org 70
62 iThis is by design, just use git locally. codemadness.org 70
63 i codemadness.org 70
64 i codemadness.org 70
65 i## Clone codemadness.org 70
66 i codemadness.org 70
67 i git clone git://git.codemadness.org/stagit codemadness.org 70
68 i codemadness.org 70
69 i codemadness.org 70
70 i## Browse codemadness.org 70
71 i codemadness.org 70
72 iYou can browse the source-code at: codemadness.org 70
73 i codemadness.org 70
74 h* https://git.codemadness.org/stagit/ URL:https://git.codemadness.org/stagit/ codemadness.org 70
75 1* gopher://codemadness.org/1/git/stagit /git/stagit codemadness.org 70
76 i codemadness.org 70
77 i codemadness.org 70
78 i## Download releases codemadness.org 70
79 i codemadness.org 70
80 iReleases are available at: codemadness.org 70
81 i codemadness.org 70
82 h* https://codemadness.org/releases/stagit/ URL:https://codemadness.org/releases/stagit/ codemadness.org 70
83 1* gopher://codemadness.org/1/releases/stagit /releases/stagit codemadness.org 70
84 .