Skip to content

๐Ÿ“ Webpack Loader for: FrontMatter (.md) -> HTML + Attributes (+ React/Vue Component)

License

Notifications You must be signed in to change notification settings

hmsk/frontmatter-markdown-loader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

frontmatter-markdown-loader

npm GitHub Workflow Status

Webpack Loader for Front Matter files (.md) which returns:

This FrontMatter markdown file something.md:

---
subject: Hello
tags:
  - tag1
  - tag2
---
# Title

message

is loadable as:

import fm from "something.md"

fm.attributes // FrontMatter attributes => { subject: "Hello", tags: ["tag1", "tag2"] }
fm.html // Compiled markdown as HTML => "<h1>Title</h1>\n<p>message</p>\n"
fm.react // Component function for React which renders compiled markdown (Disabled as default)
fm.vue.component // Extendable component object for Vue which renders compiled markdown (Disabled as default)

๐Ÿ“š See the documentation for the further detail.

๐Ÿ”ฐ You have trouble with missing object?

The loader got the breaking changes in the latest major update. The article which you referred might premise on the old version. Check the installed version, if that says 1.x.y, see this guide.

Samples

Inspired/Referred

License