Markdown: Difference between revisions
Jump to navigation
Jump to search
(→Links) |
(→Links) |
||
| Line 11: | Line 11: | ||
;Review |
;Review |
||
* [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 Asciidoctor), or reStructuredText (using 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]). |
||
== Tips == |
== Tips == |
||
Revision as of 06:23, 16 October 2018
Links
- References
- Mastering MarkDown (GitHub flavor)
- Hyperpolyglot - Markdown, reStructuredText, AsciiDoc, Mediawiki, Org-mode
- Tools
- GRIP — an offline MarkDown viewer (see tip further down also)
- Markdown viewer and editor (GitHub flavor)
- Review
- This author advocates instead AsciiDoc (using Asciidoctor), or reStructuredText (using Sphinx).
Tips
Preview Markdown before pushing to GitHub
Use the wonderful tool GRIP — GitHub README Instant Preview.
sudo apt install grip
cd /my/repo
grip # Now, open up browser to http://localhost:6419/
Comments in Markdown
We abuse link tags [1]:
[//]: # (This may be the most platform independent comment)
Align images
To center image on GitHub [2]:
<p align="center">
<img width="460" height="300" src="http://www.fillmurray.com/460/300">
</p>
To left/right align:
<img align="left" width="100" height="100" src="http://www.fillmurray.com/100/100">
<img align="right" width="100" height="100" src="http://www.fillmurray.com/100/100">