No description
Find a file
2023-12-27 09:44:45 +01:00
.forgejo/workflows add workflows and remove .github folder 2023-12-22 01:47:31 +01:00
docs remove fnNameList option for more consistency 2023-01-14 08:56:48 +09:00
etc remove fnNameList option for more consistency 2023-01-14 08:56:48 +09:00
src Add U+2063 as seperator to hashtag 2023-12-25 19:49:29 +01:00
test fix search-related tests 2023-12-26 17:15:52 +00:00
test-d chore: use test instead of it 2023-02-04 09:30:39 +09:00
.editorconfig update CI configuration 2021-04-01 11:37:44 +09:00
.eslintignore Update .eslintignore 2022-01-10 01:51:04 +09:00
.eslintrc.js Update .eslintrc.js 2022-01-31 21:29:41 +09:00
.gitignore add package-lock 2021-07-31 15:15:44 +09:00
api-extractor.json Introduce api-extractor and lint 2021-07-31 15:12:43 +09:00
CHANGELOG.md 0.24.0 2023-12-18 13:20:29 +09:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2021-08-23 23:43:00 +09:00
codecov.yml Introduce coverage integration 2021-06-26 23:48:46 +09:00
CONTRIBUTING.md Update contribution guides 2021-08-28 15:52:36 +09:00
jest.config.ts Introduce coverage integration 2021-06-26 23:48:46 +09:00
LICENSE update copyright 2022-01-01 21:57:03 +09:00
package-lock.json release minor change 2023-12-25 19:55:57 +01:00
package.json release minor change 2023-12-25 19:55:57 +01:00
README.md upd: README 2023-12-22 01:52:03 +01:00
tsconfig.json TypeScript版パーサーのマージ (#124) 2022-07-22 02:21:56 +09:00

sfm.js

An SFM parser implementation with fixes based on MFM

Installation

npm config set @sharkey:registry https://git.joinsharkey.org/api/packages/Sharkey/npm/
npm i @sharkey/sfm-js

Usage

Please see docs for the detail.

TypeScript:

import * as mfm from '@sharkey/sfm-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://git.joinsharkey.org/Sharkey/sfm.js.git

2. Install packages

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