Markdown syntax

From wikinotes

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-2

Text Formatting

*emphasize txt* _emphasize txt_  # <em>
**strong txt**  __strong txt__   # <strong>

Links

Automatic Links

<https://wikipedia.com>

External Links

See [wikipedia article](https://en.wikipedia.org/wiki/Markdown).

Relative Links

See [other page](samesite/page)

Cross-References (same-page links)

See [Official Docs][docs]

## Official Documentation [docs]

Blockquotes

a regular paragraph

> an indented
> paragraph
>
> > a double-indented paragraph

Images

![kittens](/path/to/kittens.png)

Code

Newline+Indented text is put in a pre block.

Checkout this function

    def foo(bar):
        print("baz")

Inline code is entered between `s.

The `def` here is foo.

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

Long list-items with hanging indents

* a very long list item,
  separated across multiple
  lines

Items containing quotes

* then vader says

  > I am altering the deal,
  > pray I don't alter it again

Items contianing code (indented by 8-spaces)

* check out this function

        def foo(bar):
            print("baz")