git » git-arr » commit 605421f

sample.conf: document embed_markdown and embed_images

author Eric Sunshine
2014-12-31 09:50:04 UTC
committer Alberto Bertogli
2015-01-11 21:18:00 UTC
parent df00293a7cd6e3fb11d0c1bf2fbf1c3ad485824c
sample.conf: document embed_markdown and embed_images

These repo-specific options were added in 54026b75 (Make embedding
markdown and images configurable per-repo, 2013-11-02) but not
documented.

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Alberto Bertogli <albertito@blitiri.com.ar>
sample.conf +9 -0 
diff --git a/sample.conf b/sample.conf
index 5a4db22..2ad25f0 100644
--- a/sample.conf
+++ b/sample.conf
@@ -48,6 +48,15 @@ path = /srv/git/repo/
 # excluded.
 #recursive = no
 
+# Render Markdown blobs (*.md) formatted rather than as raw text? (optional)
+# Requires 'markdown' module.
+# Default: yes
+#embed_markdown = yes
+
+# Render image blobs graphically rather than as raw binary data? (optional)
+# Default: no
+#embed_images = no
+
 
 # Another repository, we don't generate a tree for it because it's too big.
 [linux]