Move syntax highlighting to a Lua source filter

1 file changed, 11 insertions, 8 deletions

diff --git a/examples/cgitrc b/examples/cgitrcindex 62b10b5..e049d6c 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 and source syntax highlighting are built in-# and rendered in the browser, so you need no about-filter or source-filter-# for them.+# 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. # # One key=value pair per line. Lines starting with # are comments. @@ -303,10 +303,13 @@ enable-filter-overrides=0 # with exec or lua. Default is none. #owner-filter=exec:/path/to/your-command -# Filter command used to format plaintext blobs in the tree view. Syntax-# highlighting is already built in, so set this only to replace it. Value is-# a command optionally prefixed with exec or lua. Default is none.-#source-filter=exec:/path/to/your-command+# Filter command used to format plaintext blobs in the tree view. Without it+# cgit serves the text plain. For syntax highlighting, the shipped filter+# below uses the Scintillua lexers and needs the lpeg module installed too,+# on Debian that is "apt install lua-lpeg". Missing either dependency means+# plain uncolored text, not an error. See the comments in that file. Value+# is a command optionally prefixed with exec or lua. Default is none.+#source-filter=lua:/usr/share/cgit/extensions/syntax-highlight.lua  # Filter command invoked to authenticate access, gating repositories behind a # login. See extensions/auth-inline.lua and extensions/auth-file.lua. Value@@ -564,4 +567,4 @@ noplainemail=0 # Per-repo override of the owner-filter. Allowed in a repo cgitrc only when # enable-filter-overrides is 1. Value is a command. Default is the global # owner-filter value.-#repo.owner-filter=exec:/path/to/your-command
\ No newline at end of file+#repo.owner-filter=exec:/path/to/your-command
diff --git a/examples/cgitrc b/examples/cgitrc
index 62b10b5..e049d6c 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 and source syntax highlighting are built in
-# and rendered in the browser, so you need no about-filter or source-filter
-# for them.
+# 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.
 #
 # One key=value pair per line. Lines starting with # are comments.
 
@@ -303,10 +303,13 @@ enable-filter-overrides=0
 # with exec or lua. Default is none.
 #owner-filter=exec:/path/to/your-command
 
-# Filter command used to format plaintext blobs in the tree view. Syntax
-# highlighting is already built in, so set this only to replace it. Value is
-# a command optionally prefixed with exec or lua. Default is none.
-#source-filter=exec:/path/to/your-command
+# Filter command used to format plaintext blobs in the tree view. Without it
+# cgit serves the text plain. For syntax highlighting, the shipped filter
+# below uses the Scintillua lexers and needs the lpeg module installed too,
+# on Debian that is "apt install lua-lpeg". Missing either dependency means
+# plain uncolored text, not an error. See the comments in that file. Value
+# is a command optionally prefixed with exec or lua. Default is none.
+#source-filter=lua:/usr/share/cgit/extensions/syntax-highlight.lua
 
 # Filter command invoked to authenticate access, gating repositories behind a
 # login. See extensions/auth-inline.lua and extensions/auth-file.lua. Value
@@ -564,4 +567,4 @@ noplainemail=0
 # Per-repo override of the owner-filter. Allowed in a repo cgitrc only when
 # enable-filter-overrides is 1. Value is a command. Default is the global
 # owner-filter value.
-#repo.owner-filter=exec:/path/to/your-command
\ No newline at end of file
+#repo.owner-filter=exec:/path/to/your-command