git.y1.nz

sgw

Static git web (fork of stagit)
download: https://git.y1.nz/archives/sgw.tar.gz
README | Files | Log | Refs | LICENSE

README

      1 ┌─────┐
      2 │~sgw~│
      3 └─────┘
      4 
      5 Static Git Webpage (Generator).
      6 Fork of Hiltjo Posthuma's Stagit: www.codemadness.org/git/stagit/
      7 
      8 Build:
      9   Run "make" to create the sgw binary. Then, run "make install" as root
     10   to install, if that's what you want.
     11 
     12 Documentation/Usage:
     13   Calling sgw with no options will print a brief usage guide. For
     14   further info, read the man page via "mandoc sgw.1" or just
     15   "man sgw" (if you've installed sgw).
     16 
     17 Dependency:
     18   - libgit2 (v0.22+)
     19 
     20 Tool Features:
     21   - Specify output directory
     22   - Generate repository pages, index page, or both.
     23 
     24 Webpage Features:
     25   - customizable via config.h:
     26     - header/footer
     27     - webpage structure: link destinations, page locations, etc.
     28     - nested directory pages (or not)
     29   - Presents log of commits from HEAD
     30   - Presents file tree at HEAD
     31   - Text files have linkable line numbers
     32   - Binary files have preview (via object tag) and download link.
     33   - Detects README, LICENSE, and submodules and links them in repo page headers.
     34   - Atom feeds for the commits (atom.xml) and tags/refs (tags.xml).
     35   - Compatible with text-centric browsers (dillo, links, lynx and w3m).
     36 
     37 TODO:
     38   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.