Skip to content

Latest commit

 

History

History
120 lines (95 loc) · 2.13 KB

YamlSpecs.md

File metadata and controls

120 lines (95 loc) · 2.13 KB

Extensions

Adds support for YAML frontmatter parsing:

YAML frontmatter discard

If a frontmatter is present, it will not be rendered:

---
this: is a frontmatter
---
This is a text
.
<p>This is a text</p>

But if a frontmatter doesn't happen on the first line, it will be parse as regular Markdown content

This is a text1
---
this: is a frontmatter
---
This is a text2
.
<h2>This is a text1</h2>
<h2>this: is a frontmatter</h2>
<p>This is a text2</p>

It expects an exact 3 dashes ---:

----
this: is a frontmatter
----
This is a text
.
<hr />
<h2>this: is a frontmatter</h2>
<p>This is a text</p>

It can end with three dots ...:

---
this: is a frontmatter

...
This is a text
.
<p>This is a text</p>

If the end front matter marker (... or ---) is not present, it will render the --- has a <hr>:

---
this: is a frontmatter
This is a text
.
<hr />
<p>this: is a frontmatter
This is a text</p>

It expects exactly three dots ...:

---
this: is a frontmatter
....
This is a text
.
<hr />
<p>this: is a frontmatter
....
This is a text</p>

Front matter ends with the first line containing three dots ... or three dashes ---:

---
this: is a frontmatter
....

Hello
---
This is a text
.
<p>This is a text</p>

It expects whitespace can exist after the leading characters

---   
this: is a frontmatter
...
This is a text
.
<p>This is a text</p>

It expects whitespace can exist after the trailing characters

---
this: is a frontmatter
...     
This is a text
.
<p>This is a text</p>