MarkoutHTML-flavoured Markdown

Read More

Markout borrows a lot of nice features from Markdown, but uses a completely different rendering architecture that makes it easy to also leverage builtin features of the actual HTML renderer.

While the engine caters primarily to the richer features of the DOM, it does so with clear intent to make it work in a shell-based environment longer-term.

Current experimental efforts divide the rendering into two phases, the first portion uses a custom tokenizer that captures HTML and other notation, yielding the static content (HTML for now) output, the second portion uses a custom element and real-time DOM operations to yield the dynamic content (HTML for now) tailored to every aspect of the user experience.

Compatibility Notes

• [x] Headings

  • [x] HTML Headings
  • [x] ATX Headings
  • [ ] Ruled Headings Excluded

• [x] Fenced Blocks

  • [x] Syntaxes

    one of md/markdown, html, css, json, js/javascript, es/ecmascript

    defaults to markup

  • [x] Markdown Triple-Grave-Block Notation

    Note: Additionally allows annotations after close fence — not recommended for cross-compatibility.

  • [ ] Markdown Triple-Tilde-Block Excluded

  • [ ] Markdown Indented-Block Excluded

• [ ] Block Quotes

  • [x] HTML Block/Inline Quotes

  • [-] Markdown Block Quote Notation

    Note: Not yet fully implemented in some places, not limited to lists.

• [ ] Tables

  • [x] HTML Tables
  • [ ] Markdown Tables Excluded

Excluded notation is not planned to be supported by the engine directly, but indirect support can potentially be introduced in pre/post transformations.

Features

Styles

• [x] Markout Attribute Styles

  • [x] <span color:=red>one</span> one one

  • [x] … <span style:=fence>one</span> … … one … … one …

• [x] Markdown-Style Italics

  • [x] one _two_ three one two three one two three

  • [x] _one_two_three_ one_two_three one_two_three

  • [x] _one__two__three_ one__two__three one__two__three

  • [x] one *two* three one two three one two three

  • [x] one*two*three onetwothree onetwothree

  • [x] *one*_two_*three* onetwothree onetwothree

• [x] Markdown-Style Bold

  • [x] one **two** three one two three one two three

  • [x] one**two**three onetwothree onetwothree

  • [x] **one****two****three** onetwothree onetwothree

  • [x] one __two__ three one two three one two three

  • [x] _one__two__three_ one__two__three one__two__three

  • [x] __one____two____three__ one____two____three one____two____three

• [x] Markdown-Style Bold + Italics

  • [x] one **_two_ three** one two three one two three

  • [x] __*one*two*three*__ onetwothree onetwothree

• [x] Markdown-Style Strikethrough

  • [x] one ~~two~~ three one ~~two~~ three one two three

  • [x] one~~two~~three one~~two~~three onetwothree

  • [x] ~~one~~two~~three~~ ~~one~~two~~three~~ onetwothree

  • [x] ~~one~~~~two~~~~three~~ ~~one~~~~two~~~~three~~ onetwothree

• [x] Markdown-Style Escapes (ie not styled)

  • [x] one\*two\*three one*two*three one*two*three

  • [x] \_one_two_three\_ _one_two_three_ _one_two_three_

  • [x] one\**two\**three one**two**three one**two**three

  • [x] one\*\*two\*\*three one**two**three one**two**three

  • [x] one\~~two\~~three one~~two~~three one~~two~~three

  • [x] one\~\~two\~\~three one~~two~~three one~~two~~three

Links

• [x] Markdown-Style Links

- [Link]()
- [Link](?)
- [Link](#)
- [Link](./README.md)
- [Link](.)
- [Link](..)
- [Link](/)

• Link
• Link
• Link
• Link
• Link
• Link
• Link

• [x] Markdown-Style References

- [Alias Reference][referenced-alias]
- [Not Alias Reference]
- [Non-Aliased Reference][undefined-alias]

[unreferenced-alias]: ./README.md
[referenced-alias]: ./README.md

• Alias Reference
• [Not Alias Reference]
• [Non-Aliased Reference][undefined-alias]

Note: aliases render as hidden anchors

• [x] Markout-Style References

- [[Reference Link]]
- [Reference Link][]

[Reference Link]: ?

• [Reference Link]
• Reference Link

Note: aliases render as hidden anchors

Lists

Note: Markdown has limited support for this!

• [x] Markout's Unordered Lists

  • [x] Square

    • Square
      • Square
      • Disc

  • [x] Disc

    • Disc
      • Square
      • Disc

• [x] Markout's Ordered Lists

  • [x] Latin Numbering

    a) a) Latin (auto) iv. iv. Roman (coerced)

    1. 11. Arabic (coerced) g. g. Latin (coerced) a. h. Latin (auto)

  • [x] Arabic Numbering

    1. 1) Arabic (auto) g. g. Latin (coerced) iv. iv. Roman (coerced)
    11. 11. Arabic (coerced)
    12. 1. Arabic (auto)

  • [x] Roman Numbering

    i. i. Roman (auto) 11. 11. Arabic (coerced) g. g. Latin (coerced) iv. iv. Roman (coerced) i. i. Roman (auto)

• [x] Markout's Checklists

  • [x] Force-Checked

    • [x] - [x] Checked
      • [x] - [x] Checked
      • [-] - [-] Indeterminate
      • [ ] - [ ] Unchecked

  • [x] Force-Indeterminated

    • [-] - [-] Indeterminate
      • [x] - [x] Checked
      • [-] - [-] Indeterminate
      • [ ] - [ ] Unchecked

  • [x] Auto-Unchecked

    • [ ] - [ ] Unchecked
      • [x] - [x] Checked
      • [-] - [-] Indeterminate
      • [ ] - [ ] Unchecked

Headings

• [x] ATX headings

# Heading 1
---
## Heading 2
---
### Heading 3
---
#### Heading 4
---
##### Heading 5
---
###### Heading 6
---
####### No Heading 7

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5

Heading 6

####### No Heading 7

• [x] HTML headings

<h1>Heading 1</h1>

---
<h2>Heading 2</h2>

---
<h3>Heading 3</h3>

---
<h4>Heading 4</h4>

---
<h5>Heading 5</h5>

---
<h6>Heading 6</h6>

---
<h7>No Heading 7</h7>

No Heading 7

Heading Groups

Note: Markdown does not support this!

• [x] Heading groups are created from well-chained heading blocks

# Heading 1
## Subheading

---
## Heading 2
### Subheading
#### Subsubheading

---
# Heading 1
### Heading 3

---
# Heading 1

## Heading 2

Heading 1

Subheading

Heading 2

Subheading

Subsubheading

Heading 1

Heading 3

Heading 1

Heading 2