sgw | Static git web (fork of stagit) |
| download: https://git.y1.nz/archives/sgw.tar.gz | |
| README | Files | Log | Refs | LICENSE |
README
1 ____ ___
2 // \ // \\ //
3 \\__ // ____\ / //
4 \\\ // \ //\ //
5 \___// \__// \/ \/
6
7 Static Git Web (Generator)
8
9 Fork/refactor of Hiltjo Posthuma's Stagit (www.codemadness.org/git/stagit)
10
11 Build:
12 Run "make" to create the sgw binary. Then, run "make install" as root
13 to install, if that's what you want.
14
15 Documentation/Usage:
16 Calling sgw with no options will print a brief usage guide. For
17 further info, read the man page via "mandoc sgw.1" or just
18 "man sgw" (if you've installed sgw).
19
20 Dependency:
21 - libgit2 (v0.22+)
22
23 Tool Features:
24 - Specify output directory
25 - Generate repository pages, index page, or both.
26
27 Webpage Features:
28 - customizable via config.h:
29 - header/footer
30 - webpage structure: link destinations, page locations, etc.
31 - nested directory pages (or not)
32 - Presents log of commits from HEAD
33 - Presents file tree at HEAD
34 - Text files have linkable line numbers
35 - Binary files have preview (via object tag) and download link.
36 - Detects README, LICENSE, and submodules and links them in repo page headers.
37 - Atom feeds for the commits (atom.xml) and tags/refs (tags.xml).
38 - Compatible with text-centric browsers (dillo, links, lynx and w3m).
39
40 TODO:
41 See TODO.
This webpage is intended to be an accessible preview of this repository. To get a fuller picture, clone it and use the git CLI.