sfm-js/README.md
marihachi b15e4d3c2e 🐱
2021-03-21 00:36:54 +09:00

748 B
Raw Blame History

rosee

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/marihachi/rosee.git

2. Install packages

cd rosee
npm i

3. Build

npm run build

Use the interactive CLI parser

npm run parse

License

This software is released under the MIT License.