feat(#177): enable understanding of front matter #190
Conversation
**Why:**
Some users add metadata to their Markdown files in the form of
YAML-style front matter and it currently gets treated as regular
content, which looks a bit odd when rendered on the page.
Instead, we would like to be able to identify front matter and not
render it to the page. Ideally we would like to make the metadata
available and/or optionally render it to the page in some way, but this
would require some reworking of the current setup.
**What:**
* Install `markdown-it-front-matter`[^1], which enables `markdown-it` to
parse YAML-style front matter.
* Enable `markdown-it-front-matter` via `MarkdownIt.use()` like we do
with other plugins.
* **Note:** This doesn’t actually do anything other than enable
`markdown-it` to recognise front matter and not treat it as regular
content.
[^1]: https://github.com/ParkSB/markdown-it-front-matter
---
jannis-baum#177
|
Hey there! Thanks for the PR |
|
Hello, thanks again for posting the PR! Always very much appreciated :) I added an example of Markdown front matter to our render testing document, merged this am releasing 0.6.2 now with the changes. |
|
Fantastic! Happy to help, even if it is in a rather selfish scratching-my-own-itch kinda way. 😅 And thank you for creating Vivify! It’s been a life-saver ever since markdown-preview.nvim stopped working for me. ❤️ |
|
Awesome, glad to hear you like it!😊 Feel free to spread the gospel as well and star the repo if you haven't already haha |
Hi @jannis-baum, I hope you don’t mind me posting a PR out of the blue. I was looking for front matter support in Vivify and found #177. I looked into it a little bit myself and realised that we could get the basic functionality implemented by installing and enabling☺️
markdown-it-front-matter, so I thought I would just go for it!Why
Some users add metadata to their Markdown files in the form of YAML-style front matter and it currently gets treated as regular content, which looks a bit odd when rendered on the page.
Instead, we would like to be able to identify front matter and not render it to the page. Ideally we would like to make the metadata available and/or optionally render it to the page in some way, but this would require some reworking of the current setup.
What
markdown-it-front-matter1, which enablesmarkdown-itto parse YAML-style front matter.markdown-it-front-matterviaMarkdownIt.use()like we do with other plugins.markdown-itto recognise front matter and not treat it as regular content.Screenshots/recordings
Source
Output, before
Output, after
Related PRs/issues
#177
Footnotes
https://github.com/ParkSB/markdown-it-front-matter ↩