etc/sfm-js
1
0
Fork 0
mirror of https://activitypub.software/TransFem-org/sfm-js synced 2024-11-25 07:25:13 +00:00
Code Issues Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
marihachi 2021-03-27 00:34:01 +09:00
parent 73fb26c6ba
commit 8cd2d63782
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -12,20 +12,24 @@ TypeScript:
```ts ```ts
import * as mfm from 'rosee'; import * as mfm from 'rosee';
const input = const inputText =
`<center> `<center>
Hello [tada everynyan! 🎉] Hello [tada everynyan! 🎉]
I'm @ai, An bot of misskey! I'm @ai, A bot of misskey!
https://github.com/syuilo/ai https://github.com/syuilo/ai
</center>`; </center>`;
// parse a MFM text // Generate a MFM tree from the MFM text.
const result = mfm.parse(input); 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);
// parse a MFM plain text
const plainResult = mfm.parsePlain('I like the hot soup :soup:​');
``` ```
## Usage (Repository) ## Usage (Repository)