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

upd: README

Browse source
This commit is contained in:
Marie 2023-12-22 01:52:03 +01:00
parent 27dd1b6499
commit 4ead124a2a
1 changed files with 7 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,15 +1,10 @@
# mfm.js
An MFM parser implementation with TypeScript.
[Try it out!](https://runkit.com/npm/mfm-js)
[![Test](https://github.com/misskey-dev/mfm.js/actions/workflows/test.yml/badge.svg)](https://github.com/misskey-dev/mfm.js/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/misskey-dev/mfm.js/branch/develop/graph/badge.svg?token=irAWFiHK8T)](https://codecov.io/gh/misskey-dev/mfm.js)
[![NPM](https://nodei.co/npm/mfm-js.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/mfm-js)
# sfm.js
An SFM parser implementation with fixes based on MFM
## Installation
```
npm i mfm-js
npm config set @sharkey:registry https://git.joinsharkey.org/api/packages/Sharkey/npm/
npm i @sharkey/sfm-js
```
## Usage
@ -17,7 +12,7 @@ Please see [docs](./docs/index.md) for the detail.
TypeScript:
```ts
import * as mfm from 'mfm-js';
import * as mfm from '@sharkey/sfm-js';
const inputText =
`<center>
@ -42,12 +37,12 @@ const text = mfm.toString(mfmTree);
## Develop
### 1. Clone
```
git clone https://github.com/misskey-dev/mfm.js.git
git clone https://git.joinsharkey.org/Sharkey/sfm.js.git
```
### 2. Install packages
```
cd mfm.js
cd sfm.js
npm i
```