No description
Find a file
2021-03-27 19:51:39 +09:00
.github/workflows Create node.js.yml 2021-03-22 02:17:28 +09:00
src fix type definition of MfmSearch 2021-03-27 18:47:58 +09:00
test [wip] update test 2021-03-27 19:51:39 +09:00
.editorconfig add editorconfig 2021-03-22 19:50:35 +09:00
.gitignore update iroiro 2021-03-17 15:24:33 +09:00
LICENSE update iroiro 2020-02-16 23:27:25 +09:00
package.json update readme, package.json 2021-03-27 01:48:04 +09:00
README.md Update README.md 2021-03-27 16:18:40 +09:00
tsconfig.json update iroiro 2021-03-17 15:24:33 +09:00

mfm.js

An MFM parser implementation with PEG.js. Try it out!

NPM

Installation

npm i mfm-js

Usage

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 MFM text.
const mfmTree = mfm.parse(inputText);

// Generate a MFM tree from the MFM plain text.
const plainMfmTree = mfm.parsePlain('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

npm run parse

License

This software is released under the MIT License.