stagit

Personal Stagit Fork
git clone https://github.com/maydayv7/stagit

README.md (2735B)

Rendered

stagit

static git page generator.

It generates static HTML pages for a git repository.

Changes

This is my personal fork of stagit.

  • Modified styling
  • Added -n flag to set sitename for header button
  • Pages are now styled by the style.css present at root
  • Sort repositories by last commit time on index page
  • Use local system timezone
  • Custom rendering with render.py:
  • Code syntax highlighting with Pygments
  • Markdown rendering using Python-Markdown

Usage

Make files per repository:

$ mkdir -p htmldir && cd htmldir
$ stagit path-to-repo

Make index file for repositories:

$ stagit-index repodir1 repodir2 repodir3 > index.html

Build and install

$ make
# make install

Dependencies

  • C compiler (C99).
  • libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl).
  • libgit2 (v0.22+).
  • POSIX make (optional).

Documentation

See man pages: stagit(1) and stagit-index(1).

Features

  • Log of all commits from HEAD.
  • Log and diffstat per commit.
  • Show file tree with linkable line numbers.
  • Show references: local branches and tags.
  • Detect README and LICENSE file from HEAD and link it as a webpage.
  • Detect submodules (.gitmodules file) from HEAD and link it as a webpage.
  • Atom feed log (atom.xml).
  • Make index page for multiple repositories with stagit-index.
  • 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.
  • Usable with text-browsers such as dillo, links, lynx and w3m.

Cons

  • 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.
  • 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).
  • Not suitable for repositories with many branches, a quite linear history is assumed (from HEAD).

In these cases it is better to just use cgit or possibly change stagit to run as a CGI program.

  • Relatively slow to run the first time (about 3 seconds for sbase, 1500+ commits), incremental updates are faster.

  • Does not support some of the dynamic features cgit has, like:

  • Snapshot tarballs per commit.

  • File tree per commit.
  • History log of branches diverged from HEAD.
  • Stats (git shortlog -s).

This is by design, just use git locally.


Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# stagit

static git page generator.

It generates static HTML pages for a git repository.

## Changes

This is my personal [fork](https://git.codemadness.org/stagit/) of `stagit`.

- Modified styling
- Added `-n` flag to set `sitename` for header button
- Pages are now styled by the `style.css` present at root
- Sort repositories by last commit time on `index` page
- Use local system timezone
- Custom rendering with [`render.py`](./render.py):
  - Code syntax highlighting with [Pygments](https://pygments.org/)
  - Markdown rendering using [Python-Markdown](https://github.com/Python-Markdown/markdown)

## Usage

Make files per repository:

    $ mkdir -p htmldir && cd htmldir
    $ stagit path-to-repo

Make index file for repositories:

    $ stagit-index repodir1 repodir2 repodir3 > index.html

## Build and install

    $ make
    # make install

## Dependencies

- C compiler (C99).
- libc (tested with OpenBSD, FreeBSD, NetBSD, Linux: glibc and musl).
- libgit2 (v0.22+).
- POSIX make (optional).

## Documentation

See man pages: stagit(1) and stagit-index(1).

## Features

- Log of all commits from HEAD.
- Log and diffstat per commit.
- Show file tree with linkable line numbers.
- Show references: local branches and tags.
- Detect README and LICENSE file from HEAD and link it as a webpage.
- Detect submodules (.gitmodules file) from HEAD and link it as a webpage.
- Atom feed log (atom.xml).
- Make index page for multiple repositories with stagit-index.
- 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.
- Usable with text-browsers such as dillo, links, lynx and w3m.

## Cons

- 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.
- 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).
- Not suitable for repositories with many branches, a quite linear
  history is assumed (from HEAD).

  In these cases it is better to just use cgit or possibly change stagit to
  run as a CGI program.

- Relatively slow to run the first time (about 3 seconds for sbase,
  1500+ commits), incremental updates are faster.
- Does not support some of the dynamic features cgit has, like:

  - Snapshot tarballs per commit.
  - File tree per commit.
  - History log of branches diverged from HEAD.
  - Stats (git shortlog -s).

  This is by design, just use git locally.