mirror of
https://activitypub.software/TransFem-org/sfm-js
synced 2024-11-21 21:55:09 +00:00
71 lines
1.4 KiB
Markdown
71 lines
1.4 KiB
Markdown
# mfm.js
|
||
An MFM parser implementation with PEG.js.
|
||
[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 =
|
||
`<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
|
||
full parser:
|
||
```
|
||
npm run parse
|
||
```
|
||
|
||
plain parser:
|
||
```
|
||
npm run parse-plain
|
||
```
|
||
|
||
## License
|
||
This software is released under the [MIT License](LICENSE).
|