Markdown: Difference between revisions
No edit summary |
|||
| Line 8: | Line 8: | ||
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. | ||
<syntaxhighlight lang="markdown"> | <syntaxhighlight lang="markdown"> | ||
One | One line\ | ||
Another line | Another line | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 15:45, 12 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.