summaryrefslogtreecommitdiffstats
path: root/docs/content
diff options
context:
space:
mode:
authorLunny Xiao <xiaolunwen@gmail.com>2018-01-06 05:28:31 -0600
committerGitHub <noreply@github.com>2018-01-06 05:28:31 -0600
commitbf78c95d80fe1d5f034d8f0d081325ea4b764f04 (patch)
tree46460d4df30700c50f46de5f7c91ea75deed764b /docs/content
parent15b8720c5da4ad3cfca630264bef32ee3573812a (diff)
downloadgitea-bf78c95d80fe1d5f034d8f0d081325ea4b764f04.tar.gz
gitea-bf78c95d80fe1d5f034d8f0d081325ea4b764f04.zip
add external tool docs (#3301)
Diffstat (limited to 'docs/content')
-rw-r--r--docs/content/doc/advanced/config-cheat-sheet.en-us.md18
-rw-r--r--docs/content/doc/advanced/config-cheat-sheet.zh-cn.md19
2 files changed, 37 insertions, 0 deletions
diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
index 424e4264f5..63c4e7a3ed 100644
--- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md
+++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md
@@ -225,6 +225,24 @@ Note: Actually, Gitea supports only SMTP with STARTTLS.
- `MAX_GIT_DIFF_FILES`: Max number of files shown in diff view.
- `GC_ARGS`: Arguments for command `git gc`, e.g. `--aggressive --auto`.
+## markup (`markup`)
+
+Gitea supports external markup support, you can integrate all your favorite tool. For example,
+below will add a markup named `asciidoc` which is followed `markup.` ini section. And there are some config items below.
+
+```ini
+[markup.asciidoc]
+ENABLED = false
+FILE_EXTENSIONS = .adoc,.asciidoc
+RENDER_COMMAND = "asciidoc --out-file=- -"
+IS_INPUT_FILE = false
+```
+
+- ENABLED: Whether enable this tool. default is false.
+- FILE_EXTENSIONS: List of file extensions that should be rendered by an external command. Multiple extentions needs a comma as splitter.
+- RENDER_COMMAND: External command to render all matching extensions.
+- IS_INPUT_FILE: Input is not a standard input but a file param followed `RENDER_COMMAND`, default is false.
+
## Other (`other`)
- `SHOW_FOOTER_BRANDING`: Enable this to show Gitea branding in the footer.
diff --git a/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md b/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md
index 9a11d960cf..6320d6a437 100644
--- a/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md
+++ b/docs/content/doc/advanced/config-cheat-sheet.zh-cn.md
@@ -186,6 +186,25 @@ menu:
- `MAX_GIT_DIFF_FILES`: 比较视图中的最大现实文件数目。
- `GC_ARGS`: 执行 `git gc` 命令的参数, 比如: `--aggressive --auto`。
+## markup (`markup`)
+
+外部渲染工具支持,你可以用你熟悉的文档渲染工具. 比如一下将新增一个名字为 `asciidoc` 的渲染工具which is followed `markup.` ini section. And there are some config items below.
+
+```ini
+[markup.asciidoc]
+ENABLED = false
+FILE_EXTENSIONS = .adoc,.asciidoc
+RENDER_COMMAND = "asciidoc --out-file=- -"
+IS_INPUT_FILE = false
+```
+
+- ENABLED: 是否启用,默认为false。
+- FILE_EXTENSIONS: 关联的文档的扩展名,多个扩展名用都好分隔。
+- RENDER_COMMAND: 工具的命令行命令及参数。
+- IS_INPUT_FILE: 输入方式是最后一个参数为文件路径还是从标准输入读取。
+
+
+
## Other (`other`)
- `SHOW_FOOTER_BRANDING`: 为真则在页面底部显示Gitea的字样。