Markdown: Difference between revisions

From David's Wiki
 
(3 intermediate revisions by the same user not shown)
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.
<syntaxhighlight lang="markdown">
<pre>
One line\
One line\
Another line
Another line
</syntaxhighlight>
</pre>


==Renderers==
==Renderers==
Below are a few programs scripts for rendering Markdown.
Below are a few programs and scripts for rendering Markdown.


;Libraries
* [https://docsify.js.org/#/ Docsify] ([https://github.com/docsifyjs/docsify/ GitHub, 15k Stars])
* [https://docsify.js.org/#/ Docsify] ([https://github.com/docsifyjs/docsify/ GitHub, 15k Stars])
** JS only. Supports multiple pages and search. Many addons.
** 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://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://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])  
* [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])
* [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==
==Resources==

Latest revision as of 14:43, 9 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 and scripts for rendering Markdown.

Libraries
Wikis and Content management systems
Servers

Resources