# parcel-plugin-markdown-string
**Repository Path**: mirrors_jaywcjlove/parcel-plugin-markdown-string
## Basic Information
- **Project Name**: parcel-plugin-markdown-string
- **Description**: 📦@parcel-bundler plugin for loader markdown string, markdown output HTML.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-22
- **Last Updated**: 2025-09-21
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
parcel-transformer-markdown
===
[](https://jaywcjlove.github.io/#/sponsor)
[](https://www.npmjs.com/package/parcel-transformer-markdown)
[](https://github.com/jaywcjlove/parcel-plugin-markdown-string/actions/workflows/ci.yml)
[](https://www.npmjs.com/package/parcel-transformer-markdown)
[](https://www.npmjs.com/package/parcel-plugin-markdown-string)
[**`Parcel 2`**](https://parceljs.org/) plugin for loader markdown string, markdown output HTML.
> ⚠️ ~~[`parcel-plugin-markdown-string`](https://github.com/jaywcjlove/parcel-plugin-markdown-string/tree/parcel-plugin-markdown-string)~~ => [`parcel-transformer-markdown`](https://www.npmjs.com/package/parcel-transformer-markdown)
```diff
- parcel-plugin-markdown-string
+ parcel-transformer-markdown
```
## Example usage
Install the plugin
```bash
npm install parcel-transformer-markdown --save-dev
```
`.parcelrc`
```js
{
"extends": "@parcel/config-default",
"transformers": {
"*.md": [ "parcel-transformer-markdown" ]
}
}
```
`index.html`:
```html
```
**Output HTML string**
Import your markdown files! Output HTML string.
```js
import HTMLStr from './Markdown.md';
console.log(HTMLStr) // => Output HTML string.
document.body.innerHTML = HTMLStr;
```
**Output Markdown string**
```js
// .markedrc
{
"marked": false
}
```
```js
import str from './Markdown.md';
console.log(str) // => Output Markdown string.
document.body.innerHTML = str;
```
## Configuration
[Marked](https://github.com/markedjs/marked) can be configured using a `.markedrc`, `.markedrc.js`, or `marked.config.js` file. See the [Marked API Reference](https://marked.js.org/using_advanced#options) for details on the available options.
> Note: `.markedrc.js` and `marked.config.js` are 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.
```js
{
"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](https://github.com/jaywcjlove/github-action-contributors).
## License
MIT © [Kenny Wong](https://wangchujiang.com)