Markdown syntax: Difference between revisions
From wikinotes
No edit summary |
(→Links) |
||
Line 35: | Line 35: | ||
== Links == | == Links == | ||
<blockquote> | <blockquote> | ||
External Links | |||
<syntaxhighlight lang="md"> | |||
See [wikipedia article](https://en.wikipedia.org/wiki/Markdown). | |||
</syntaxhighlight> | |||
Relative Links | |||
<syntaxhighlight lang="md"> | |||
See [other page](../other/page) | |||
</syntaxhighlight> | |||
Cross-References (same-page links) | Cross-References (same-page links) | ||
Line 43: | Line 52: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</blockquote><!-- Links --> | </blockquote><!-- Links --> | ||
== Code == | |||
<blockquote> | |||
Newline+Indented text is put in a <code>pre</code> block. | |||
<syntaxhighlight lang="md"> | |||
Checkout this function | |||
def foo(bar): | |||
print("baz") | |||
</syntaxhighlight> | |||
</blockquote><!-- Code --> | |||
== Lists == | == Lists == |
Revision as of 13:39, 19 September 2021
These notes are based on the base markdown spec. Ideally, this should be supported by all parsers.
Parsers may introduce additional features.
Documentation
official docs https://daringfireball.net/projects/markdown/syntax
Syntax
Headers
Headers can be defined using hash prefix, or underlines.
# Header 1 ## Header 2 ### Header 3 Header 1 ======== Header 2 --------For underlines, the character matters
=
for header-1-
for header-2Links
External Links
See [wikipedia article](https://en.wikipedia.org/wiki/Markdown).Relative Links
See [other page](../other/page)Cross-References (same-page links)
See [Official Docs][docs] ## Official Documentation [docs]Code
Newline+Indented text is put in a
pre
block.Checkout this function def foo(bar): print("baz")Lists
List Types
Unordered lists can be defined with
*
,+
, or-
.* red + yellow - blueOrdered lists use numbers with periods.
1. one 2. two 3. threeList Items
Long list-items with hanging indents
* a very long list item, separated across multiple linesItems containing quotes
* then vader says > I am altering the deal, > pray I don't alter it againItems contianing code (indented by 8-spaces)
* check out this function def foo(bar): print("baz")