repo2html

a command-line tool that turns git repositories in html pages

features

static html files
image support (we're working on this)
svg support (we're working on this)
markdown files are rendered as html (we're working on this)
no background process (unless you're using this tool as a post-receive hook, then you only need git-daemon running)
default repository view is an html-rendered README.md file

binary file contents are just... shown
directory tree is shown as a flat list of files, so git repositories with many files and directories will look awful
no commit log (yet?)
no line numbers (yet?)

no one is liable if this software breaks, deletes, corrupts, or ruins anything

note: if you have chicken scheme installed, then you can install the eggs above by running make dependencies as root.

chicken scheme runs faster if it's compiled to a binary file. by default, the binary is named repo2html, and is installed in /usr/local/bin.

to compile repo2html into a binary file, follow the steps below:

TODO

TODO

TODO

you can configure repo2html by changing environment variables in the post-receive hook file.

for details about the environment variables, refer to the list below:

REPO2HTML_PREFIX: the web directory where repo2html generates static git repositories. for example, /var/www/git/.
REPO2HTML_CLONE_URL: the url that people will use when downloading your git repository. if you have git-daemon set up, then you can prefix the url with git://. otherwise, prefix the url with http://. for example, git://git.example.com. note: avoid slashes at the end of the url.
REPO2HTML_TITLE: the text that populates the <title> html tag.
REPO2HTML_DESCRIPTION: a string that populates the description meta information about your git repository.
REPO2HTML_H1: the text that populates the <h1> html tag.

TODO

update docs according to changes in 50bbb3686d37fc00c95aedde82bc7a58de53b410. m455 updated things a bit, but he wants to touch up on way more things documentation-wise according to the changes in this commit.
e2e tutorial
if no README.md file exists in the root directory of the repository, then don't create the "about" nav link. instead, make the files page the index.html
add a "license" nav link if a LICENSE file exists in the root directory of the repository. if no LICENSE file exists, then don't create the "license" nav link
add a "contributors" nav link

clickable line numbers in source files
make repos with more files and directories less daunting (recursively generate a files list page for each directory in a repo?)
nav link: Releases