forgejo/docs/content/doc/administration
Mike Rochefort d7e669c371
Update Asciidoc markup example with safe defaults (#24920)
The cheat sheet uses the `asciidoc` markup language to demonstrate how
to set up third party markup renderers. The current example has the
following issues:

- It promotes a legacy tool that does not handle modern AsciiDoc
specifications
- It does not account for embedded preview renders
- It has no safety restrictions

By switching to `asciidoctor`, uses are suggested to utilize de
facto/standard tooling for AsciiDoc.

The `--embedded` parameter will strip out HTML tags that contain the
document (such as `<html></html>`) which aren't necessary for the
render, and actually end up as text in the document if left in.

The `--safe-mode` parameter (of which there are several profiles)
imposes [certain
policies](https://docs.asciidoctor.org/asciidoctor/latest/safe-modes/)
on the files it ingests and what the resulting output looks like. GitHub
itself uses the `secure` profile (the highest), which can be a good
starting point for those who are uncertain of what to do. By default, if
no mode is specified when `asciidoctor` runs it defaults to `unsafe`,
i.e. no safety guidelines at all.
2023-05-25 01:24:05 +00:00
..
_index.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
_index.zh-cn.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
_index.zh-tw.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
adding-legal-pages.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
adding-legal-pages.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
backup-and-restore.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
backup-and-restore.zh-cn.md Remove unnecessary usage prefix from doc titles (#24869) 2023-05-23 18:14:57 +08:00
backup-and-restore.zh-tw.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
cmd-embedded.en-us.md Remove font-awesome and fomantic icon module (#24471) 2023-05-01 13:25:54 -04:00
cmd-embedded.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
command-line.en-us.md Update LDAP filters to include both username and email address (#24547) 2023-05-05 14:18:53 -04:00
command-line.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
config-cheat-sheet.en-us.md Update Asciidoc markup example with safe defaults (#24920) 2023-05-25 01:24:05 +00:00
config-cheat-sheet.zh-cn.md Update Asciidoc markup example with safe defaults (#24920) 2023-05-25 01:24:05 +00:00
customizing-gitea.en-us.md Support changing git config through app.ini, use diff.algorithm=histogram by default (#24860) 2023-05-23 16:30:19 +00:00
customizing-gitea.zh-cn.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
email-setup.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
email-setup.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
environment-variables.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
environment-variables.zh-cn.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
external-renderers.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
external-renderers.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
fail2ban-setup.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
fail2ban-setup.zh-cn.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
git-lfs-support.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
git-lfs-support.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
https-support.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
https-support.zh-cn.md Remove unnecessary usage prefix from doc titles (#24869) 2023-05-23 18:14:57 +08:00
logging-config.en-us.md Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
logging-config.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
mail-templates.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
mail-templates.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
repo-indexer.en-us.md Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
repo-indexer.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
reverse-proxies.en-us.md Improve reverse-proxy document and fix nginx config bug (#24616) 2023-05-10 05:28:44 +00:00
reverse-proxies.zh-cn.md Remove unnecessary usage prefix from doc titles (#24869) 2023-05-23 18:14:57 +08:00
search-engines-indexation.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
search-engines-indexation.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00
signing.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
signing.zh-cn.md zh-cn translation for administration docs (#24881) 2023-05-24 10:35:43 +08:00