clone url: git://git.m455.casa/repo2html
A command-line tool that generates a static HTML representation of a Git repository.
repo2html <destination> <template-directory>
Run repo2html
inside the root directory of a Git repository or a bare Git
repository.
<destination>
is the path to the directory that you want the HTML files to
be generated in.<template-directory>
is the path to the directory that contains a
default.html
file. Refer to assets/templates/default.html
for an example
default.html
file.The HTML that's generated represents the state of the HEAD
commit, not the
current state of the work tree.
This section guides you through installing the required dependencies, compiling
a binary, and then installing the binary. By default, repo2html
installs
into the /usr/local/bin
directory.
repo2html
git repository.make dependencies
to install the required Chicken Scheme eggs.make
to compile a static repo2html
binary in the current directory.make install
to copy the repo2html
binary into the
/usr/local/bin
directory.Note: If you want to use main.scm
as the repo2html
executable, instead
of compiling a static binary file, then run
cp main.scm /usr/local/bin/repo2html
as root.
You can repo2html
by changing the following items:
You can customize repo2html
by editing the assets/templates/default.html
,
and then specifying the path to the default.html
file as the second
command-line argument when running repo2html
.
For example, if you placed a default.html
file in ~/bin
, and you serve HTML
files from /var/www/git
, then you run repo2html /var/www/git ~/bin
.
You can provide a generic description by setting the REPO2HTML_DESCRIPTION
environment variable, or by adding a description in a description
file in the
root directory of your Git repository.
Refer to
Create a Git forge with repo2html
to learn how use repo2html
in a post-receive
hook to auto-generate HTML
representations of bare Git repositories on a remote web server after you git
push
to them.
hexdump
, xxd
, dumpelf
, elfls
, readelf
, etc.?