Skip to content

Commit 75d07f7

Browse files
committed
new markdown resources
1 parent 22c0f99 commit 75d07f7

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

content/pages/05-documentation/03-markdown.markdown

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,21 @@ other formats such as HTML and JSON.
2424

2525

2626
## Markdown resources
27+
Markdown does not have an extensive set of strict rules like some other
28+
text formats so you should be able to read up on the basics with these
29+
articles then write a few practice documents to be comfortable with it.
30+
The following resources are really helpful when you are getting started
31+
or need a quick reference on a less commonly-used feature such as tables
32+
or block quotes.
33+
34+
* [Say yes to Markdown, no to MS Word](https://medium.com/@drodil/say-yes-to-markdown-no-to-ms-word-be4692e7a8cd)
35+
provides a really awesome overview of why Markdown is a more usable file
36+
format than Microsoft Word and similar proprietary file types. The article
37+
also has a good list of useful Markdown-related tools such as a
38+
[Markdown-to-PDF converter](https://github.com/alanshaw/markdown-pdf)
39+
(a NodeJS package but easy enough to use with a basic development
40+
environment).
41+
2742
* [Markdown syntax](https://daringfireball.net/projects/markdown/syntax)
2843
is the defacto standard and wonderful reading for both initial learning
2944
and random reference.
@@ -36,3 +51,19 @@ other formats such as HTML and JSON.
3651
reviews many of the most common Python Markdown parser implementations
3752
to give insight into the advantages and disadvantages of each one.
3853

54+
* [reStructuredText vs Markdown for documentation](http://zverovich.net/2016/06/16/rst-vs-markdown.html)
55+
brings up some really good points about the downsides to Markdown's
56+
simplicity. First, a lot of documentation needs more complex output that
57+
is not possible with vanilla Markdown so you need to drop into plain old
58+
HTML, which defeats the purpose of using a markup language. Second, some
59+
of the syntax around inserting blank lines by adding spaces at the end
60+
of lines is confusing if someone is using a
61+
[text editor or development environment](/text-editors-ides.html) that
62+
is not configured to show blank spaces. Worse yet, if your editor is set to
63+
remove blank spaces at the end of lines, which is fairly common among
64+
developers, then you can mistakenly break the formatting intended by
65+
the original author. Overall this is a good piece to read for a balanced
66+
view of Markdown and the reasons it provides are one reason why I use
67+
both Markdown and reStructuredText depending on the project.
68+
69+

0 commit comments

Comments
 (0)