@smotaal.io/markout NPM

MarkoutHTML-flavoured Markdown

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

- HTML Headings
- ATX Headings
- Ruled Headings Excluded
- Syntaxes
  one of md/markdown, html, css, json, js/javascript, es/ecmascript
  defaults to markup
- 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
- HTML Block/Inline Quotes
- - Markdown Block Quote Notation
  Note: Not yet fully implemented in some places, not limited to lists.
- 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

Links

Markdown-Style Links

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

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

Note: aliases render as hidden anchors

Markout-Style References

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

[Reference Link]: ?

Note: aliases render as hidden anchors

Lists

Note: Markdown has limited support for this!

- Square
  - Square
    - Square
    - Disc
- Disc
  - Disc
    - Square
    - Disc
- Latin Numbering
  a) a) Latin (auto) iv. iv. Roman (coerced)
  1. 11. Arabic (coerced) g. g. Latin (coerced) a. h. Latin (auto)
- Arabic Numbering
  1) 1) Arabic (auto) g. g. Latin (coerced) iv. iv. Roman (coerced)
  1. 11. Arabic (coerced)
  2. 1. Arabic (auto)
- Roman Numbering
  i. i. Roman (auto)
  1. 11. Arabic (coerced) g. g. Latin (coerced) iv. iv. Roman (coerced) i. i. Roman (auto)
- Force-Checked
  - - [x] Checked
    - - [x] Checked
    - - - [-] Indeterminate
    - - [ ] Unchecked
- Force-Indeterminated
  - - - [-] Indeterminate
    - - [x] Checked
    - - - [-] Indeterminate
    - - [ ] Unchecked
- Auto-Unchecked
  - - [ ] Unchecked
    - - [x] Checked
    - - - [-] Indeterminate
    - - [ ] Unchecked

Headings

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

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!

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

@infinitebrahmanuniverse/nolb-_smo @everything-registry/sub-chunk-846 @zalastax/nolb-_smo

0.0.1-pre.1

4 years ago