Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
S
sfm-js
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Requirements
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
dakkar
sfm-js
Commits
4ead124a
Commit
4ead124a
authored
1 year ago
by
Marie
Browse files
Options
Downloads
Patches
Plain Diff
upd: README
parent
27dd1b64
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+7
-12
7 additions, 12 deletions
README.md
with
7 additions
and
12 deletions
README.md
+
7
−
12
View file @
4ead124a
# mfm.js
# sfm.js
An MFM parser implementation with TypeScript.
An SFM parser implementation with fixes based on MFM
[
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
## Installation
```
```
npm i mfm-js
npm config set @sharkey:registry https://git.joinsharkey.org/api/packages/Sharkey/npm/
npm i @sharkey/sfm-js
```
```
## Usage
## Usage
...
@@ -17,7 +12,7 @@ Please see [docs](./docs/index.md) for the detail.
...
@@ -17,7 +12,7 @@ Please see [docs](./docs/index.md) for the detail.
TypeScript:
TypeScript:
```
ts
```
ts
import
*
as
mfm
from
'
m
fm-js
'
;
import
*
as
mfm
from
'
@sharkey/s
fm-js
'
;
const
inputText
=
const
inputText
=
`<center>
`<center>
...
@@ -42,12 +37,12 @@ const text = mfm.toString(mfmTree);
...
@@ -42,12 +37,12 @@ const text = mfm.toString(mfmTree);
## Develop
## Develop
### 1. Clone
### 1. Clone
```
```
git clone https://git
hub.com/misskey-dev/m
fm.js.git
git clone https://git
.joinsharkey.org/Sharkey/s
fm.js.git
```
```
### 2. Install packages
### 2. Install packages
```
```
cd
m
fm.js
cd
s
fm.js
npm i
npm i
```
```
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment