stencil-markdown
This package allows you to import the content of a Markdown file into Stencil Components.
Under the hood, it converts your Markdown to JSX.
First, npm install within the project:
npm install stencil-markdown --save-dev
Next, within the project's stencil.config.js
file, import the plugin and add it to the config's plugins
config:
stencil.config.ts
;; ;
During development, this plugin will kick-in for explicitly imported .md
or .markdown
files, and convert them to a FunctionalComponent.
my-component.ts
;;
In order to allow Typescript to import .md or .markdown files, please add the following file to your project in the src/
directory.
index.d.ts
;
Frontmatter
Stencil Markdown parses YAML Frontmatter—no configuration needed.
hello-world.md
---title: Hello world!---## Hey, world!
my-component.ts
;;
Options
Marked options can be passed to the plugin within stencil.config.js
, which are used directly by marked
. Please reference marked documentation for all available options.