Markdown: Difference between revisions
| Line 22: | Line 22: | ||
* [https://casual-effects.com/markdeep/ Markdeep] ([https://github.com/morgan3d/markdeep GitHub]) | * [https://casual-effects.com/markdeep/ Markdeep] ([https://github.com/morgan3d/markdeep GitHub]) | ||
** Syntax extends markdown. Only supports a single page. | ** Syntax extends markdown. Only supports a single page. | ||
* [https://readthedocs.org/ Read the Docs] ([https://github.com/readthedocs/readthedocs.org GitHub]) | |||
==Resources== | ==Resources== | ||
Revision as of 19:31, 13 August 2020
Markdown is the typesetting language used in Github and elsewhere (including Google).
Syntax
See #Resources
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.
- 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)
- MDwiki (GitHub) (unmaintained since 2018)
- Markdeep (GitHub)
- Syntax extends markdown. Only supports a single page.
- Read the Docs (GitHub)