Markdown syntax: Difference between revisions
From wikinotes
Line 65: | Line 65: | ||
=== List Items === | === List Items === | ||
<blockquote> | <blockquote> | ||
Long list-items with hanging indents | |||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
* a very long list item, | * a very long list item, | ||
separated across multiple | separated across multiple | ||
lines | lines | ||
</syntaxhighlight> | |||
Items containing quotes | |||
<syntaxhighlight lang="bash"> | |||
* then vader says | |||
> I am altering the deal, | |||
> pray I don't alter it again | |||
</syntaxhighlight> | |||
Items contianing code (indented by 8-spaces) | |||
<syntaxhighlight lang="bash"> | |||
* check out this function | |||
def foo(bar): | |||
print("baz") | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</blockquote><!-- List Items --> | </blockquote><!-- List Items --> | ||
</blockquote><!-- Lists --> | </blockquote><!-- Lists --> | ||
</blockquote><!-- Syntax --> | </blockquote><!-- Syntax --> |
Revision as of 13:32, 19 September 2021
These notes are based on the base markdown spec.
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
Cross-References (same-page links)
See [Official Docs][docs] ## Official Documentation [docs]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")