Asciidoc: Difference between revisions
Jump to navigation
Jump to search
(→Tips) |
|||
| Line 8: | Line 8: | ||
* [http://ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/ Why You Shouldn’t Use “Markdown” for Documentation] |
* [http://ericholscher.com/blog/2016/mar/15/dont-use-markdown-for-technical-docs/ Why You Shouldn’t Use “Markdown” for Documentation] |
||
:This author advocates instead AsciiDoc (using [https://asciidoctor.org/ Asciidoctor]), or reStructuredText (using [http://www.sphinx-doc.org/en/stable/usage/quickstart.html Sphinx]). |
:This author advocates instead AsciiDoc (using [https://asciidoctor.org/ Asciidoctor]), or reStructuredText (using [http://www.sphinx-doc.org/en/stable/usage/quickstart.html Sphinx]). |
||
== Reference == |
|||
=== Extension === |
|||
Recommended extension on [https://github.com/github/markup#markups GitHub] is {{file|.asciidoc}}, {{file|.adoc}} or simply {{file|.asc}}. |
|||
== Tips == |
== Tips == |
||
Latest revision as of 06:32, 16 October 2018
Links
- Reference
- Powerman's Asciidoc Cheat sheet
- Hyperpolyglot - Markdown, reStructuredText, AsciiDoc, Mediawiki, Org-mode
- Review
- This author advocates instead AsciiDoc (using Asciidoctor), or reStructuredText (using Sphinx).
Reference
Extension
Recommended extension on GitHub is .asciidoc, .adoc or simply .asc.
Tips
Use Icons
By default, asciidoc does not use icons. To enable them:
asciidoc -a icons -a iconsdir=/etc/asciidoc/images/icons file.txt