Markdown: Difference between revisions
| Line 7: | Line 7: | ||
Newlines in markdown can be created with either two trailing whitespaces or a trailing backslash. | 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. | The Google Style Guide suggests using a trailing backslash and never using trailing whitespaces. | ||
< | <pre> | ||
One line\ | One line\ | ||
Another line | Another line | ||
</ | </pre> | ||
==Renderers== | ==Renderers== | ||
Revision as of 15:46, 3 February 2021
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.
- 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
- Servers