Asciidoc: Difference between revisions
Jump to navigation
Jump to search
(Created page with '== References == * [http://powerman.name/doc/asciidoc Powerman's Asciidoc Cheat sheet]') |
(→Tips) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== |
== Links == |
||
;Reference |
|||
* [http://powerman.name/doc/asciidoc Powerman's Asciidoc Cheat sheet] |
* [http://powerman.name/doc/asciidoc Powerman's Asciidoc Cheat sheet] |
||
* [http://hyperpolyglot.org/lightweight-markup Hyperpolyglot - Markdown, reStructuredText, AsciiDoc, Mediawiki, Org-mode] |
|||
;Review |
|||
* [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]). |
|||
== Reference == |
|||
=== Extension === |
|||
Recommended extension on [https://github.com/github/markup#markups GitHub] is {{file|.asciidoc}}, {{file|.adoc}} or simply {{file|.asc}}. |
|||
== Tips == |
|||
=== Use Icons === |
|||
By default, ''asciidoc'' does not use icons. To enable them: |
|||
<source lang=bash> |
|||
asciidoc -a icons -a iconsdir=/etc/asciidoc/images/icons file.txt |
|||
</source> |
|||
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