Diff options
| author | Bryce Kwon <bryce@brycekwon.com> | |
|---|---|---|
| committer | Bryce Kwon <bryce@brycekwon.com> | |
| commit | ||
| parent | ||
| tree | ||
| download | ||
Describe root-readme as the site's about page
Diffstat (limited to 'MANUAL.txt')
| -rw-r--r-- | MANUAL.txt | 28 |
1 file changed, 15 insertions, 13 deletions
@@ -22,10 +22,11 @@ about-filter:: content of the about-file on its stdin and the name of the file, with the tree url its links resolve against, as arguments, and the stdout from the command will be included verbatim on the about page. Default - value: none. When no about-filter is set, the readme is escaped and - served as plain text. A bundled Lua filter, about-render.lua, renders - markdown, man pages and plain text when about-filter points at it. See - also: "Filter API". + value: none. When no about-filter is set, a repository's readme is + escaped and served as plain text, while root-readme is included + verbatim. A bundled Lua filter, about-render.lua, renders markdown, man + pages and plain text when about-filter points at it. See also: "Filter + API". age-file:: Specifies a path, relative to each repository path, which can be used to @@ -442,9 +443,10 @@ root-desc:: value: "a fast webinterface for the git dscm". root-readme:: - The content of the file specified with this option will be included - verbatim below the "about" link on the repository index page. Default - value: none. + A file shown as the site's own about page, which an "about" tab on the + repository index page leads to once this is set. The file goes through + about-filter when one is set and is included verbatim otherwise. + Default value: none. root-title:: Text printed as heading on the repository index page. Default value: @@ -703,12 +705,12 @@ repo.path:: this is the .git-directory. Default value: none. repo.readme:: - A path (relative to <repo.path>) which specifies a file to include - verbatim as the "About" page for this repository. A git refspec by head - or by hash may be prepended, followed by a colon, as in - "master:docs/readme.mkd". If the value begins with a colon, as in - ":docs/readme.rst", the head given in the query or the default branch of - the repository is used. Default value: <readme>. + A path (relative to <repo.path>) which specifies a file to show as the + "About" page for this repository. A git refspec by head or by hash may + be prepended, followed by a colon, as in "master:docs/readme.mkd". If + the value begins with a colon, as in ":docs/readme.rst", the head given + in the query or the default branch of the repository is used. Default + value: <readme>. repo.section:: Override the current section name for this repository. Default value: |