diff options
context:
space:
mode:
authorBryce Kwon <bryce@brycekwon.com>
committerBryce 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 'examples')
-rw-r--r--examples/cgitrc19
1 file changed, 7 insertions, 12 deletions
diff --git a/examples/cgitrc b/examples/cgitrc
index 5626b58..bb87a9b 100644
--- a/examples/cgitrc
+++ b/examples/cgitrc
@@ -11,9 +11,9 @@
# directory, or list repositories by hand in the per-repository section at
# the end of this file.
#
-# In this fork, markdown readmes are rendered in the browser, so no
-# about-filter is needed for them. Source syntax highlighting is optional
-# and ships as a source-filter, see the filter section below.
+# About pages (markdown, man and plain-text readmes) render through the
+# bundled about-render.lua about-filter, see the filter section below. Source
+# syntax highlighting is optional and ships as a source-filter there too.
#
# One key=value pair per line. Lines starting with # are comments.
@@ -237,10 +237,6 @@ enable-tree-linenumbers=1
# Default is 0.
enable-tree-group-dirs=0
-# Render a markdown readme client-side on the about page. Values are 0 or 1.
-# Default is 1.
-enable-markdown=1
-
# Default maximum statistics period. Leaving this unset disables statistics.
# Values are week, month, quarter or year. Default is unset.
#max-stats=week
@@ -288,10 +284,10 @@ enable-http-clone=1
# 0 or 1. Default is 0.
enable-filter-overrides=0
-# Filter command used to format about-page content. Markdown already renders
-# in the browser, so this is only for other formats such as man pages. Value
-# is a command optionally prefixed with exec or lua. Default is none.
-#about-filter=exec:/path/to/your-command
+# Filter command used to format about-page content. The bundled about-render.lua
+# renders markdown, man pages and plain text. Value is a command optionally
+# prefixed with exec or lua. Default is none.
+#about-filter=lua:/usr/share/cgit/extensions/about-render.lua
# Filter command used to format commit messages, for example to turn object
# names and issue numbers into links. Value is a command optionally prefixed
@@ -563,4 +559,3 @@ noplainemail=0
# enable-filter-overrides is 1. Value is a command. Default is the global
# email-filter value.
#repo.email-filter=lua:/usr/share/cgit/extensions/email-gravatar.lua
-