1# stagit
 2
 3Static git page generator.
 4
 5## Changes
 6
 7This is my personal fork of [stagit](https://git.codemadness.org/stagit/).
 8
 9- Added `-n` to set the site name
10- Pages use `/style.css` from the site root
11- Sort repositories by last commit time on the index page
12- Use local timezone for short dates
13- Custom rendering with [`render.py`](./render.py):
14  - Code syntax highlighting with [Pygments](https://pygments.org/)
15  - Markdown rendering with [Python-Markdown](https://github.com/Python-Markdown/markdown)
16  - Tables, task lists, GitHub callouts and math markup
17- File and diff previews limited to 2 MiB
18- Modified markup and shared elements through the website's [build](../default.nix) and [assembly](../assemble.py)
19
20## Usage
21
22Build the complete Git site from the repo root:
23
24```sh
25nix run .#gitsite
26```
27
28To generate standalone pages directly:
29
30```sh
31mkdir -p htmldir && cd htmldir
32stagit -n maydayv7 /path/to/repo
33```
34
35Make the repository index:
36
37```sh
38stagit-index -n maydayv7 repodir1 repodir2 > index.html
39```
40
41## Build and Install
42
43From the repo root:
44
45```sh
46nix build .#stagit
47```
48
49Or build manually from this directory:
50
51```sh
52make
53make install
54```
55
56## Documentation
57
58See [stagit(1)](./stagit.1) and [stagit-index(1)](./stagit-index.1).