mirror/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-11-11 04:26:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 9
forgejo/docs/content/doc
History
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
..
administration Update Asciidoc markup example with safe defaults (#24920) 2023-05-25 01:24:05 +00:00
contributing Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
development Fix broken links in documents (#24630) 2023-05-10 12:34:16 +00:00
help Fix document and improve comment (#24844) 2023-05-22 08:47:33 +00:00
installation Make environment-to-ini support loading key value from file (#24832) 2023-05-24 11:37:22 +08:00
usage Rename docs packages title from xxx Packages Repository -> xxx Package Registry (#24895) 2023-05-24 06:21:39 +00:00
actions.en-us.md Docs for Gitea Actions (#24405) 2023-05-05 20:07:20 +00:00
administration.en-us.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
administration.fr-fr.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
administration.zh-cn.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
administration.zh-tw.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
contributing.en-us.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
contributing.fr-fr.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
contributing.zh-tw.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
development.en-us.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
development.zh-cn.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
development.zh-tw.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
help.en-us.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
help.fr-fr.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
help.zh-cn.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
help.zh-tw.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
installation.en-us.md Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
installation.fr-fr.md General documentation cleanup (#3317) 2018-01-08 23:48:42 +01:00
installation.zh-cn.md Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
installation.zh-tw.md Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
packages.en-us.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
search.de-de.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
search.en-us.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
search.fr-fr.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
search.nl-nl.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
search.pt-br.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
search.zh-cn.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
search.zh-tw.md Refactor docs (#23752) 2023-04-28 11:33:41 +08:00
usage.en-us.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
usage.zh-cn.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00
usage.zh-tw.md Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629) 2023-03-23 23:18:24 +08:00