minor modifications to stagit
Find a file
Hiltjo Posthuma f96ac27087 no log per branch
rename log.html to log/HEAD.html, small code cleanup
2016-01-03 22:36:48 +01:00
compat.h add compat.h 2015-12-26 13:01:41 +01:00
config.def.h Add config.def.h and make summary length configurable 2015-12-14 12:49:58 +01:00
config.mk rename EXTRAOBJ to COMPATOBJ 2015-12-26 20:11:59 +01:00
example.sh improve README 2015-12-27 19:05:45 +01:00
favicon.png add favicon 2015-12-07 14:41:54 +01:00
LICENSE Add myself to LICENSE 2015-12-08 00:36:06 +01:00
logo.png initial insertion 2015-12-04 16:58:04 +01:00
Makefile rename urmoms to stagit, improve documentation 2015-12-26 21:05:55 +01:00
README improve README 2015-12-27 19:05:45 +01:00
stagit-index.1 rename urmoms to stagit, improve documentation 2015-12-26 21:05:55 +01:00
stagit-index.c rename urmoms to stagit, improve documentation 2015-12-26 21:05:55 +01:00
stagit.1 rename urmoms to stagit, improve documentation 2015-12-26 21:05:55 +01:00
stagit.c no log per branch 2016-01-03 22:36:48 +01:00
strlcat.c compat: add strlcpy, strlcat, for glibc 2015-12-25 17:48:46 +01:00
strlcpy.c compat: add strlcpy, strlcat, for glibc 2015-12-25 17:48:46 +01:00
style.css index: highlight row on mouseover 2015-12-26 12:54:09 +01:00
TODO add refs page (branches and tags) 2016-01-03 21:06:03 +01:00

stagit
======

static git page generator


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


Install
-------

$ make
# doas make install


Dependencies
------------

- libgit2 (v0.22+).
- C compiler
- make


Documentation
-------------

$ man stagit
$ man stagit-index


Features
--------

- Log of all commits.
- Log and diffstat per commit.
- Show file tree with linkable line numbers.
- Detect README and LICENSE file from HEAD and link it as a webpage.
- Atom feed log.
- 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.


Cons
----

- Not suitable for large repositories (2000+ commits).
- Not suitable for repositories with many branches, a quite linear history is assumed.
- Relatively slow to run the first time (about 3 seconds for sbase, 1500+ commits),
  incremental updates after it are faster.