Skip to content

kokonect-link/mfc.js

 
 

Repository files navigation

mfc.js

An MFC parser implementation with TypeScript. Try it out!

Test codecov

NPM

Installation

npm i mfc-js

Usage

Please see docs for the detail.

TypeScript:

import * as mfc from 'mfc-js';

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

I'm @ai, A bot of cherrypick!

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

// Generate a MFC tree from the full MFC text.
const mfmTree = mfm.parse(inputText);

// Generate a MFC tree from the simple MFC text.
const simpleMfmTree = mfm.parseSimple('I like the hot soup :soup:​');

// Reverse to a MFC text from the MFC tree.
const text = mfm.toString(mfmTree);

Develop

1. Clone

git clone https://github.com/kokonect-link/mfc.js.git

2. Install packages

cd mfc.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.

About

An CFM parser implementation with TypeScript.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 99.1%
  • JavaScript 0.9%