sfm-js/README.md

mfm.js

Description

A MFM parser implementation with PEG.js

Installation

npm i rosee

Usage

TypeScript:

import * as mfm from 'rosee';

const input =
`<center>
Hello [tada everynyan! 🎉]

I'm @ai, An bot of misskey!

https://github.com/syuilo/ai
</center>`;

// parse a MFM text
const result = mfm.parse(input);

// parse a MFM plain text
const plainResult = mfm.parsePlain('I like the hot soup :soup:​');

Usage (Repository)

1. Clone

git clone https://github.com/misskey-dev/mfm.js.git

2. Install packages

cd mfm.js
npm i

3. Build

npm run build

Use the interactive CLI parser

npm run parse

License

This software is released under the MIT License.