diff --git a/Makefile b/Makefile index 19b63d1..2d6c2b3 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -DEPS = utf8 lowdown +DEPS = utf8 lowdown sxml-transforms clojurian SRC = main.scm DIR_INSTALL ?= /usr/local/bin DIR_BUILD = . diff --git a/README.md b/README.md index b3d444c..ea62ae0 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@ a post-receive hook that generates an html view of a git repository. ## features - static html files +- image support +- svg support +- markdown files are rendered as html - no background process other than git-daemon - default repository view is an html-rendered README.md file @@ -26,6 +29,8 @@ no one is liable if this software breaks, deletes, corrupts, or ruins anything - [chicken scheme](https://call-cc.org/) - [utf8 egg](https://wiki.call-cc.org/eggref/5/utf8) - [lowdown egg](https://wiki.call-cc.org/eggref/5/lowdown) +- [sxml-transforms egg](https://wiki.call-cc.org/eggref/5/sxml-transforms) +- [clojurian egg](https://wiki.call-cc.org/eggref/5/clojurian) - git **note**: if you have chicken scheme installed, then you can install the eggs @@ -43,17 +48,29 @@ to compile repo2html into a binary file, follow the steps below: 3. run `make` 4. run `make install` as root +## installation + +TODO + +## using repo2html as a post-receive hook + +TODO + +## using repo2html as a standalone command-line utility + +TODO + ## configuration 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: -- `GIT_WWW`: the web directory where repo2html generates static git repositories. for example, `/var/www/git/`. -- `GIT_WWW_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. -- `GIT_WWW_TITLE`: the text that populates the `` html tag. -- `GIT_WWW_DESCRIPTION`: a string that populates the `description` meta information about your git repository. -- `GIT_WWW_H1`: the text that populates the `<h1>` html tag. +- `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. ## how it works @@ -61,13 +78,14 @@ TODO ## todos -- ☐ 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 +- 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 ## hopes -- ☐ clickable line numbers in source files -- ☐ render images -- ☐ make repos with more files and directories less daunting (recursively generate a files list page for each directory in a repo?) -- ☐ nav link: Releases +- 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