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