No description

Find a file

pho4cexa 35496ee17e enable customizable jinja-like templates via ersatz! well this was a journey :) behavior when running `repo2html <output directory>` remains the same; we apply our internal sxml template as usual. to use ersatz templates, run like this: `repo2html <output directory> <template directory>` the program will look for a "default.html" file in that directory.		2022-12-16 13:31:39 -05:00
ISSUES	add some data for issue tracker	2022-12-12 11:07:26 -05:00
templates	enable customizable jinja-like templates via ersatz!	2022-12-16 13:31:39 -05:00
.gitignore	lightened shade of the default pink	2022-12-02 16:47:20 -05:00
.mailmap	map e-mail addresses to canonical names!	2022-12-10 20:17:13 -05:00
build-a-git-forge.md	attempt to better conform to m455's styleguide	2022-12-11 21:03:33 -05:00
git-daemon.service	first commit	2022-12-02 16:41:55 -05:00
LICENSE	added license :)	2022-12-04 00:51:48 -05:00
main.scm	enable customizable jinja-like templates via ersatz!	2022-12-16 13:31:39 -05:00
Makefile	added new dependencies to readme and makefile	2022-12-13 17:02:01 -05:00
post-receive	massive changes incl. support for images, markdown	2022-12-07 14:51:23 -05:00
README.md	enable customizable jinja-like templates via ersatz!	2022-12-16 13:31:39 -05:00

README.md

repo2html

generates static html pages for browsing the contents of a git repository.

basic usage

repo2html <destination>

run from a git repository, this command populates the directory <destination> with html files that provide a web-browsable view of the contents of repository.

note: changes must be at least committed before they will appear in the html output. more precisely: the html output represents the state of the HEAD commit, not that of the current work-tree.

you may also cause this html directory to be automatically updated upon every git push, by invoking repo2html from a git hook. we describe how to use this technique to build a static git forge.

features

static html files
image support
markdown files are rendered as html
no resident background process

disclaimer

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

requirements

chicken scheme, and eggs:
- clojurian
- ersatz
- lowdown
- scss
- srfi-1
- srfi-13
- srfi-14
- sxml-transforms
- symbol-utils
- utf8
git

installation

this compiles the binary repo2html and place it in /usr/local/bin.

ensure you're in the repo2html git repository
as root, run make dependencies
run make
run make install as root

if you wish, you may then uninstall the chicken scheme compiler.

if you prefer, the file main.scm may be used as the repo2html executable instead of compiling a binary file, but it will be slower, and requires that the chicken scheme interpreter remain installed on your system.

how it works

TODO

todos

documentation: convert a lot of the stuff i (m455) made in the readme into an e2e tutorial
documenation: scope the readme audience to folks who kind of know what they're doing with servers
documentation/feature: use post-update rather than post-receive hook for simplicity
documentation: also describe use with post-commit hook
feature: multi-page or collapse-able files list
feature: branches and releases (tags)
feature: clickable line numbers in source files
feature: display binary files as output from binary-file analysis tools like hexdump, xxd, dumpelf, elfls, readelf, etc.?
feature: syntax highlighting?
feature: markdown-render git log text
feature: other mechanisms for header id application like uniqueness checking, sequential numbering