Skip to content

An MFM parser implementation with TypeScript.

License

Notifications You must be signed in to change notification settings

nekoplanet/mfm.js

This branch is 9 commits ahead of misskey-dev/mfm.js:develop.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Dec 28, 2024
0ded7ed · Dec 28, 2024
Jun 13, 2024
Jan 13, 2023
Jun 15, 2024
Oct 22, 2024
Jun 13, 2024
Jun 13, 2024
Apr 1, 2021
Jan 9, 2022
Jun 13, 2024
Dec 28, 2024
Dec 18, 2023
Aug 23, 2021
Aug 28, 2021
Jan 1, 2022
Dec 28, 2024
Jul 31, 2021
Jun 26, 2021
Jun 26, 2021
Dec 28, 2024
Dec 28, 2024
Oct 22, 2024
Jul 21, 2022

Repository files navigation

mfm.js

An MFM parser implementation with TypeScript. Try it out!

Test codecov

NPM

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/nekoplanet/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.

About

An MFM parser implementation with TypeScript.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.1%
  • JavaScript 1.9%