mirror of
https://activitypub.software/TransFem-org/sfm-js
synced 2024-11-21 21:55:09 +00:00
docs
This commit is contained in:
parent
c75f8d2272
commit
11fefdffe0
1 changed files with 10 additions and 1 deletions
11
docs/api.md
11
docs/api.md
|
@ -9,7 +9,7 @@ console.log(JSON.stringify(nodes));
|
|||
// => [{"type":"text","props":{"text":"hello "}},{"type":"fn","props":{"name":"tada","args":{}},"children":[{"type":"text","props":{"text":"world"}}]}]
|
||||
```
|
||||
|
||||
### 利用可能なMFM関数のリストを設定する
|
||||
### 利用可能なMFM関数やカスタム絵文字のリストを設定する
|
||||
MFM関数の名前をホワイトリストに登録して、登録されたMFM関数以外を通常のテキストノードとして解釈するように設定できます。
|
||||
デフォルトではすべてのMFM関数名を受け入れるように設定されています。
|
||||
|
||||
|
@ -26,6 +26,15 @@ console.log(JSON.stringify(nodes));
|
|||
// => [{"type":"text","props":{"text":"hello $[pope world]"}}]
|
||||
```
|
||||
|
||||
同様に、カスタム絵文字の名前もホワイトリスト制にできます。
|
||||
|
||||
例:
|
||||
```ts
|
||||
const nodes = mfm.parse(':bap:', { emojiCodeList: ['polarbear', 'bap'] });
|
||||
console.log(JSON.stringify(nodes));
|
||||
// => [{"type":"emojiCode","props":{"name":"bap"}}]
|
||||
```
|
||||
|
||||
### 最大のネストの深さを変更する
|
||||
デフォルトで20に設定されています。
|
||||
|
||||
|
|
Loading…
Reference in a new issue