Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jaywcjlove/parcel-plugin-markdown-string
📦@parcel-bundler plugin for loader markdown string, markdown output HTML.
https://github.com/jaywcjlove/parcel-plugin-markdown-string
markdown markdown-to-html parcel-bundler parcel-plugin parceljs
Last synced: 14 days ago
JSON representation
📦@parcel-bundler plugin for loader markdown string, markdown output HTML.
- Host: GitHub
- URL: https://github.com/jaywcjlove/parcel-plugin-markdown-string
- Owner: jaywcjlove
- License: mit
- Created: 2018-03-16T13:17:19.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-08-07T04:23:39.000Z (5 months ago)
- Last Synced: 2024-10-29T11:16:06.579Z (2 months ago)
- Topics: markdown, markdown-to-html, parcel-bundler, parcel-plugin, parceljs
- Language: TypeScript
- Homepage: https://jaywcjlove.github.io/parcel-plugin-markdown-string
- Size: 498 KB
- Stars: 21
- Watchers: 3
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-parcel - Markdown String - Plugin for markdown string support. (Plugins / Templates)
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)