No description

Find a file

pho4cexa a97c673158 simplify main readme by moving "git forge" specifics elsewhere just a suggestion; don't feel obligated to merge. you know technical writing and documentation better than i do!		2022-12-09 13:14:09 -05:00
.gitignore	lightened shade of the default pink	2022-12-02 16:47:20 -05:00
build-a-git-forge.md	simplify main readme by moving "git forge" specifics elsewhere	2022-12-09 13:14:09 -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	check file existence in source-files-list not cwd	2022-12-09 12:54:56 -05:00
Makefile	don't fail build if build directory exists	2022-12-07 21:10:28 -05:00
post-receive	massive changes incl. support for images, markdown	2022-12-07 14:51:23 -05:00
README.md	simplify main readme by moving "git forge" specifics elsewhere	2022-12-09 13:14:09 -05:00

README.md

repo2html

repo2html generates static HTML pages for browsing the contents of a Git repository.

basic usage

repo2html DESTINATION

Assuming the current directory is a Git repository, this command populates DESTINATION with HTML files that provide a web-browsable view of the contents of the git 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 (if any).

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:
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: need better detection and rendering of binary files
feature: multi-page or collapse-able files list
feature: commit log
feature: branches and releases (tags)
feature: clickable line numbers in source files
feature: customizable templates
feature: display binary files as output from binary-file analysis tools like hexdump, xxd, dumpelf, elfls, readelf, etc.?
feature: syntax highlighting?