Markdown: Difference between revisions

Revision as of 15:45, 3 February 2021

Markdown is the typesetting language used in Github and elsewhere (including Google).

Syntax

Newlines

Newlines in markdown can be created with either two trailing whitespaces or a trailing backslash.
The Google Style Guide suggests using a trailing backslash and never using trailing whitespaces.

One line\
Another line

Renderers

Below are a few programs scripts for rendering Markdown.

Libraries

Docsify (GitHub, 15k Stars)
- JS only. Supports multiple pages and search. Many addons.
Docusaurus (GitHub, 18k Stars) - This is made by Facebook.
MKDocs (GitHub, 11K Stars)
Markdeep (GitHub)
- Syntax extends markdown. Only supports a single page.
Read the Docs (GitHub)

Wikis and Content management systems

MDwiki (GitHub) (unmaintained since 2018)
wiki.js

Servers

Caddy

@@ Line 15: / Line 15: @@
 Below are a few programs scripts for rendering Markdown.
+; Libraries
 * [https://docsify.js.org/#/ Docsify] ([https://github.com/docsifyjs/docsify/ GitHub, 15k Stars])
 ** JS only. Supports multiple pages and search. Many addons.
 * [https://docusaurus.io/en/ Docusaurus] ([https://github.com/facebook/docusaurus GitHub, 18k Stars]) - This is made by Facebook.
 * [https://www.mkdocs.org/ MKDocs] ([https://github.com/mkdocs/mkdocs/ GitHub, 11K Stars])
-* [https://dynalon.github.io/mdwiki/#!index.md MDwiki] ([https://github.com/Dynalon/mdwiki/ GitHub]) (unmaintained since 2018)
 * [https://casual-effects.com/markdeep/ Markdeep] ([https://github.com/morgan3d/markdeep GitHub])
 ** Syntax extends markdown. Only supports a single page.
 * [https://readthedocs.org/ Read the Docs] ([https://github.com/readthedocs/readthedocs.org GitHub])
+; Wikis and Content management systems
+* [https://dynalon.github.io/mdwiki/#!index.md MDwiki] ([https://github.com/Dynalon/mdwiki/ GitHub]) (unmaintained since 2018)
+* [https://wiki.js.org/ wiki.js]
+; Servers
+* [https://caddyserver.com/ Caddy]
 ==Resources==