From 89d5543d7eb4b9b96badbb9e4dd967e2f4dce02c Mon Sep 17 00:00:00 2001 From: Mike Rochefort Date: Wed, 24 May 2023 18:56:19 -0400 Subject: [PATCH] Update Asciidoc markup example with safe defaults - Change from 'asciidoc' to 'asciidoctor' for rendering. - GitHub renders previews under the "secure" profile. This is a reasonable default to demonstrate for those who may not be well versed in what Asciidoc can do or are not advanced sysadmins. - Add embedded parameter to strip out document containing tags that will otherwise be displayed in text form when rendered. --- docs/content/doc/administration/config-cheat-sheet.en-us.md | 2 +- docs/content/doc/administration/config-cheat-sheet.zh-cn.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/content/doc/administration/config-cheat-sheet.en-us.md b/docs/content/doc/administration/config-cheat-sheet.en-us.md index 18321ee8833cb..e7e482fc7924a 100644 --- a/docs/content/doc/administration/config-cheat-sheet.en-us.md +++ b/docs/content/doc/administration/config-cheat-sheet.en-us.md @@ -1118,7 +1118,7 @@ Gitea can support Markup using external tools. The example below will add a mark ENABLED = true NEED_POSTPROCESS = true FILE_EXTENSIONS = .adoc,.asciidoc -RENDER_COMMAND = "asciidoc --out-file=- -" +RENDER_COMMAND = "asciidoctor --embedded --safe-mode=secure --out-file=- -" IS_INPUT_FILE = false ``` diff --git a/docs/content/doc/administration/config-cheat-sheet.zh-cn.md b/docs/content/doc/administration/config-cheat-sheet.zh-cn.md index c672b61598fde..ba28b98123fa9 100644 --- a/docs/content/doc/administration/config-cheat-sheet.zh-cn.md +++ b/docs/content/doc/administration/config-cheat-sheet.zh-cn.md @@ -337,7 +337,7 @@ test01.xls: application/vnd.ms-excel; charset=binary ENABLED = false NEED_POSTPROCESS = true FILE_EXTENSIONS = .adoc,.asciidoc -RENDER_COMMAND = "asciidoc --out-file=- -" +RENDER_COMMAND = "asciidoctor --embedded --safe-mode=secure --out-file=- -" IS_INPUT_FILE = false ```