parcel-transformer-markdown
v3.0.1
Published
Parcel plugin for loader markdown string & Markdown transformer.
Downloads
362
Maintainers
wcjiangReadme
parcel-transformer-markdown
Parcel 2 plugin for loader markdown string, markdown output HTML.
⚠️ ~~
parcel-plugin-markdown-string~~ =>parcel-transformer-markdown
- parcel-plugin-markdown-string
+ parcel-transformer-markdownExample usage
Install the plugin
npm install parcel-transformer-markdown --save-dev.parcelrc
{
"extends": "@parcel/config-default",
"transformers": {
"*.md": [ "parcel-transformer-markdown" ]
}
}index.html:
<!DOCTYPE html>
<div id="root"></div>
<script type="module" src="index.js"></script>Output HTML string
Import your markdown files! Output HTML string.
import HTMLStr from './Markdown.md';
console.log(HTMLStr) // => Output HTML string.
document.body.innerHTML = HTMLStr;Output Markdown string
// .markedrc
{
"marked": false
}import str from './Markdown.md';
console.log(str) // => Output Markdown string.
document.body.innerHTML = str;Configuration
Marked can be configured using a .markedrc, .markedrc.js, or marked.config.js file. See the Marked API Reference for details on the available options.
Note:
.markedrc.jsandmarked.config.jsare supported for JavaScript-based configuration, but should be avoided when possible because they reduce the effectiveness of Parcel's caching. Use a JSON based configuration format (e.g..markedrc) instead.
There is a marked configuration that converts markdown to HTML. Otherwise just read the markdown string.
{
"marked": {
"breaks": true,
"pedantic": false,
"gfm": true,
"tables": true,
"sanitize": false,
"smartLists": true,
"smartypants": false,
"xhtml": false
}
}Contributors
As always, thanks to our amazing contributors!
Made with github-action-contributors.
License
MIT © Kenny Wong