Markdown syntax: Difference between revisions

From wikinotes
Line 16: Line 16:
<blockquote>
<blockquote>
Headers can be defined using hash prefix, or underlines.
Headers can be defined using hash prefix, or underlines.
<syntaxhighlight lang="md">
<pre>
# Header 1
# Header 1
## Header 2
## Header 2
Line 26: Line 26:
Header 2
Header 2
--------
--------
</syntaxhighlight>
</pre>


For underlines, the character matters
For underlines, the character matters

Revision as of 13:27, 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-2

Links

Cross-References (same-page links)

See [Official Docs][docs]

## Official Documentation [docs]

Lists

List Types

Unordered lists can be defined with *, +, or -.

* red
+ yellow
- blue

Ordered lists use numbers with periods.

1. one
2. two
3. three

List Items

# Lists support hanging indents
* a very long list item,
  separated across multiple
  lines