🐙 Templated web page generator for your git repositories
git clone https://github.com/m-col/gitja
Files | Refs | Readme | License

Commit 09f8f52648c2b4f141426296ce9377242391fba5
Parent: 515e729ceeb5bbd0326ea2dd38a33b3df4db939c
Author: mcol <mcol@posteo.net>
Date: 2021-09-24 22:55:18 +0100
Committer: mcol <mcol@posteo.net>
Committed: 2021-09-24 22:55:18 +0100

Add section to readme about template variable scopes

README.rst Modified

@@ -3,7 +3,8 @@
 
 This is all a work in progress and so nothing is implemented.
 
-gitserve generates pretty web pages from your git repositories.
+gitserve generates pretty web pages from your git repositories using custom
+HTML templates.
 
 It has two modes of operations:
 
@@ -28,3 +29,15 @@
 - Log index + page per commit
 - Refs + tags index
 - atom xml for repository
+
+
+Template variables
+------------------
+
+There are two variable scopes. Only one is available in a given template:
+
+- *Repository scope*: This exposes information that pertains to a single
+  repository. Most templates are rendered once per configured repository.
+- *Index scope*: This exposes information about the whole set of repositories.
+  The index template is rendered once in total and uses this scope. This
+  template is specified in the ``indexTemplate`` setting.