forked from nbsp/marked-mfm
32 lines
1.2 KiB
Markdown
32 lines
1.2 KiB
Markdown
# marked-mfm
|
|
a [Marked.js](https://marked.js.org) custom extension for [Misskey-flavored Markdown](https://github.com/misskey-dev/mfm.js/blob/develop/docs/syntax.md).
|
|
|
|
this is a reimplementation of [the original MFM parser](https://github.com/misskey-dev/mfm.js/blob/develop/docs/syntax.md), which was written from the ground up using PEG.js instead of as an extension of CommonMark, and therefore was not up to spec.
|
|
this extension is mostly compatible with the original, except it only implements `$[tags]`. mentions, hashtags and the `search` markup are out of scope.
|
|
|
|
## usage
|
|
|
|
```js
|
|
const marked = require('marked')
|
|
const markedMfm = require('marked-mfm')
|
|
|
|
marked.use(markedMfm)
|
|
marked.parse('$[x2 beeg text]')
|
|
// <p><span class="mfm _mfm_x2_" >beeg text</span></p>
|
|
```
|
|
|
|
there is also an interactive CLI:
|
|
|
|
```html
|
|
$ npm run dingus
|
|
marked-mfm interactive parser
|
|
version 0.0.0
|
|
> $[x2 beeg text]
|
|
<p><span class="mfm _mfm_x2_" >beeg text</span></p>
|
|
```
|
|
|
|
you should use it to figure out whether a bug is with marked-mfm or with the frontend it's used on.
|
|
|
|
## contributing
|
|
|
|
development discussion takes place on [`#mfm`](https://irc.akkoma.dev/#mfm). contribute by sending pull requests, or patches to my [public inbox](mailto:~sfr/public-inbox@lists.sr.ht).
|