diff options
| author | Bryce Kwon <bryce@brycekwon.com> | |
|---|---|---|
| committer | Bryce Kwon <bryce@brycekwon.com> | |
| commit | ||
| parent | ||
| tree | ||
| download | ||
Replace the browser markdown renderer with a filter
The readme is now escaped plain text unless `about-filter` points at
the new `about-render.lua`, which renders markdown, man pages and plain
text server-side. `enable-markdown` goes away with the renderer.
Diffstat (limited to '')
| -rw-r--r-- | cgitrc.5.txt | 19 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1 file changed, 6 insertions, 13 deletions
diff --git a/cgitrc.5.txt b/cgitrc.5.txt index 049b234..32f8b86 100644 --- a/cgitrc.5.txt +++ b/cgitrc.5.txt @@ -32,8 +32,9 @@ about-filter:: get the content of the about-file on its STDIN, the name of the file as the first argument, and the STDOUT from the command will be included verbatim on the about page. Default value: none. When no - about-filter is set, a markdown readme is instead rendered by the - bundled cgit.js (see enable-markdown). See also: "FILTER API". + 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". agefile:: Specifies a path, relative to each repository path, which can be used @@ -241,14 +242,6 @@ enable-tree-group-dirs:: in git's own order, with directories and files intermixed by name. Default value: "0". -enable-markdown:: - Flag which, when set to "1", renders a markdown readme on the about - page. cgit escapes the source and a small renderer bundled in cgit.js - formats it in the browser, so the page stays readable as plain text - when scripting is off. It applies only when no about-filter handles the - file, and only to names ending in .md, .markdown, .mkd or .mdown. - Default value: "1". - favicon:: Url used as link to the icon for cgit. Any path works, but keeping the value "/favicon.ico" is still worthwhile, since clients that do @@ -955,9 +948,9 @@ mimetype.svg=image/svg+xml # extensions/syntax-highlight.lua highlights through the Scintillua lexers. # source-filter=lua:/usr/share/cgit/extensions/syntax-highlight.lua -# Markdown about pages render client-side by default (see enable-markdown). -# For other formats such as manpages, point about-filter at your own script. -# about-filter=/var/www/cgit/filters/my-about-formatter +# About pages are escaped plain text unless an about-filter is set. The shipped +# extensions/about-render.lua renders markdown, man pages and plain text. +# about-filter=lua:/usr/share/cgit/extensions/about-render.lua ## ## Search for these files in the root of the default branch of repositories |