Markdown: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
Markdown is the typesetting language used in Github and elsewhere (including Google). | 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. | |||
<syntaxhighlight lang="markdown"> | |||
One line | |||
Next line\ | |||
Another line | |||
</syntaxhighlight> | |||
==Renderers== | ==Renderers== | ||
| Line 16: | Line 27: | ||
* [https://learnxinyminutes.com/docs/markdown/ Learn Markdown in Y Minutes] | * [https://learnxinyminutes.com/docs/markdown/ Learn Markdown in Y Minutes] | ||
* [https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet Adam P's Markdown Cheatsheet] | * [https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet Adam P's Markdown Cheatsheet] | ||
* [https://www.markdownguide.org/basic-syntax/ Markdown Guide] | |||
* [https://github.com/google/styleguide/blob/gh-pages/docguide/style.md Google Markdown Style Guide] | |||
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
Next 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.