https://github.com/misskey-dev/mfm.js
An MFM parser implementation with TypeScript.
https://github.com/misskey-dev/mfm.js
mfm mfm-parser misskey parser typescript
Last synced: 8 days ago
JSON representation
An MFM parser implementation with TypeScript.
- Host: GitHub
- URL: https://github.com/misskey-dev/mfm.js
- Owner: misskey-dev
- License: mit
- Created: 2020-01-29T23:45:09.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-18T09:55:46.000Z (3 months ago)
- Last Synced: 2025-06-18T23:35:54.353Z (19 days ago)
- Topics: mfm, mfm-parser, misskey, parser, typescript
- Language: TypeScript
- Homepage:
- Size: 621 KB
- Stars: 122
- Watchers: 6
- Forks: 33
- Open Issues: 43
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# mfm.js
An MFM parser implementation with TypeScript.
[Try it out!](https://runkit.com/npm/mfm-js)
[](https://github.com/misskey-dev/mfm.js/actions/workflows/test.yml)
[](https://codecov.io/gh/misskey-dev/mfm.js)
[](https://www.npmjs.com/package/mfm-js)
## Installation
```
npm i mfm-js
```
## Usage
Please see [docs](./docs/index.md) for the detail.
TypeScript:
```ts
import * as mfm from 'mfm-js';
const inputText =
`
Hello $[tada everynyan! 🎉]
I'm @ai, A bot of misskey!
https://github.com/syuilo/ai
`;
// 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](LICENSE).