mirror of
https://activitypub.software/TransFem-org/sfm-js
synced 2024-11-21 21:55:09 +00:00
aa893a8477
* implement plain syntax * public api * plain syntax * public api * plain syntax * Update test/parser.ts Co-authored-by: syuilo <Syuilotan@yahoo.co.jp> * plain parser -> simple parser * nomfm -> plain Co-authored-by: syuilo <Syuilotan@yahoo.co.jp>
1.4 KiB
1.4 KiB
mfm.js
An MFM parser implementation with PEG.js. Try it out!
Installation
npm i mfm-js
Usage
Please see docs for the detail.
TypeScript:
import * as mfm from 'mfm-js';
const inputText =
`<center>
Hello $[tada everynyan! 🎉]
I'm @ai, A bot of misskey!
https://github.com/syuilo/ai
</center>`;
// Generate a MFM tree from the full MFM text.
const mfmTree = mfm.parse(inputText);
// Generate a MFM tree from the simple MFM text.
const simpleMfmTree = mfm.parseSimple('I like the hot soup :soup:');
// Reverse to a MFM text from the MFM tree.
const text = mfm.toString(mfmTree);
Develop
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
full parser:
npm run parse
simple parser:
npm run parse-simple
License
This software is released under the MIT License.