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

update syntax doc

Browse source
This commit is contained in:
marihachi 2021-09-30 11:12:45 +09:00
parent 7df1daaea9
commit 6d2a064362
1 changed files with 21 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
docs/syntax.md
View file

@ -26,7 +26,7 @@
<h1 id="quote">引用ブロック</h1> <h1 id="quote">Block: 引用ブロック</h1>
## 形式 ## 形式
``` ```
@ -46,7 +46,6 @@
``` ```
## 詳細 ## 詳細
- ブロック構文です。
- 引用された内容には再度FullParserを適用する。 - 引用された内容には再度FullParserを適用する。
- `>`の後に続く0～1文字のスペースを無視する。 - `>`の後に続く0～1文字のスペースを無視する。
- 隣接する引用の行は一つになる。 - 隣接する引用の行は一つになる。
@ -55,7 +54,7 @@
<h1 id="search">検索ブロック</h2> <h1 id="search">Block: 検索ブロック</h2>
## 形式 ## 形式
``` ```
@ -77,12 +76,11 @@ MFM 書き方 [検索]
``` ```
## 詳細 ## 詳細
- ブロック構文。
- Searchの大文字小文字は区別されない。 - Searchの大文字小文字は区別されない。
<h1 id="code-block">コードブロック</h2> <h1 id="code-block">Block: コードブロック</h2>
## 形式 ## 形式
<pre> <pre>
@ -113,12 +111,11 @@ abc
``` ```
## 詳細 ## 詳細
- ブロック構文です。
- langは指定されない場合はnullになる。 - langは指定されない場合はnullになる。
<h1 id="math-block">数式ブロック</h2> <h1 id="math-block">Block: 数式ブロック</h2>
## 形式 ## 形式
``` ```
@ -142,14 +139,13 @@ a = 2
``` ```
## 詳細 ## 詳細
- ブロック構文です。
- `\[`は行頭でなければならない。 - `\[`は行頭でなければならない。
- `\]`は行末でなければならない。 - `\]`は行末でなければならない。
- 前後のスペースと改行はトリミングされる。 - 前後のスペースと改行はトリミングされる。
<h1 id="center">中央寄せブロック</h2> <h1 id="center">Block: 中央寄せブロック</h2>
## 形式 ## 形式
``` ```
@ -172,7 +168,6 @@ abc
``` ```
## 詳細 ## 詳細
- ブロック構文。
- `<center>`は行頭でなければならない。 - `<center>`は行頭でなければならない。
- `</center>`は行末でなければならない。 - `</center>`は行末でなければならない。
- 中身を空にすることはできない。 - 中身を空にすることはできない。
@ -180,7 +175,7 @@ abc
<h1 id="big">揺れる字</h2> <h1 id="big">Inline: 揺れる字</h2>
**廃止予定の構文。代替の構文が用意されています。** **廃止予定の構文。代替の構文が用意されています。**
## 形式 ## 形式
@ -203,13 +198,12 @@ abc
``` ```
## 詳細 ## 詳細
- インライン構文
- 内容には再度InlineParserを適用する。 - 内容には再度InlineParserを適用する。
- 内容には改行も含めることが可能です。 - 内容には改行も含めることが可能です。
<h1 id="bold">太字</h2> <h1 id="bold">Inline: 太字</h2>
## 形式 ## 形式
構文1: 構文1:
@ -238,7 +232,6 @@ __bold__
``` ```
## 詳細 ## 詳細
- インライン構文。
- 内容には再度InlineParserを適用する。 - 内容には再度InlineParserを適用する。
構文1,3のみ: 構文1,3のみ:
@ -249,7 +242,7 @@ __bold__
<h1 id="small">目立たない字</h2> <h1 id="small">Inline: 目立たない字</h2>
## 形式 ## 形式
``` ```
@ -267,13 +260,12 @@ __bold__
``` ```
## 詳細 ## 詳細
- インライン構文です。
- 内容には再度InlineParserを適用する。 - 内容には再度InlineParserを適用する。
- 内容には改行も含めることが可能です。 - 内容には改行も含めることが可能です。
<h1 id="italic">イタリック</h2> <h1 id="italic">Inline: イタリック</h2>
## 形式 ## 形式
構文1: 構文1:
@ -302,7 +294,6 @@ _italic_
``` ```
## 詳細 ## 詳細
- インライン構文。
- 内容には再度InlineParserを適用する。 - 内容には再度InlineParserを適用する。
構文1のみ: 構文1のみ:
@ -315,7 +306,7 @@ _italic_
<h1 id="strike">打ち消し線</h2> <h1 id="strike">Inline: 打ち消し線</h2>
## 形式 ## 形式
構文1: 構文1:
@ -339,7 +330,6 @@ _italic_
``` ```
## 詳細 ## 詳細
- インライン構文。
- 内容には再度InlineParserを適用する。 - 内容には再度InlineParserを適用する。
構文1のみ: 構文1のみ:
@ -350,7 +340,7 @@ _italic_
<h1 id="inline-code">インラインコード</h2> <h1 id="inline-code">Inline: インラインコード</h2>
## 形式 ## 形式
``` ```
@ -368,13 +358,12 @@ _italic_
``` ```
## 詳細 ## 詳細
- インライン構文。
- 内容には改行を含めることができない。 - 内容には改行を含めることができない。
- 内容には「´」を含めることができない。 - 内容には「´」を含めることができない。
<h1 id="math-inline">インライン数式</h2> <h1 id="math-inline">Inline: インライン数式</h2>
## 形式 ## 形式
``` ```
@ -392,12 +381,11 @@ _italic_
``` ```
## 詳細 ## 詳細
- インライン構文。
- 内容には改行を含めることができない。 - 内容には改行を含めることができない。
<h1 id="mention">メンション</h2> <h1 id="mention">Inline: メンション</h2>
## 形式 ## 形式
``` ```
@ -431,7 +419,6 @@ _italic_
``` ```
## 詳細 ## 詳細
- インライン構文。
- 最初の`@`の前の文字が(改行、スペース、無し、[a-zA-Z0-9]に一致しない)のいずれかの場合にメンションとして認識する。 - 最初の`@`の前の文字が(改行、スペース、無し、[a-zA-Z0-9]に一致しない)のいずれかの場合にメンションとして認識する。
### ユーザ名 ### ユーザ名
@ -446,7 +433,7 @@ _italic_
<h1 id="hashtag">ハッシュタグ</h2> <h1 id="hashtag">Inline: ハッシュタグ</h2>
## 形式 ## 形式
``` ```
@ -464,7 +451,6 @@ _italic_
``` ```
## 詳細 ## 詳細
- インライン構文。
- 内容には半角スペース、全角スペース、改行、タブ文字を含めることができない。 - 内容には半角スペース、全角スペース、改行、タブ文字を含めることができない。
- 内容には`.` `,` `!` `?` `'` `"` `#` `:` `/` `【` `】` `<` `>` を含めることができない。 - 内容には`.` `,` `!` `?` `'` `"` `#` `:` `/` `【` `】` `<` `>` を含めることができない。
- 括弧は対になっている時のみ内容に含めることができる。対象: `()` `[]` `「」` - 括弧は対になっている時のみ内容に含めることができる。対象: `()` `[]` `「」`
@ -473,7 +459,7 @@ _italic_
<h1 id="url">URL</h2> <h1 id="url">Inline: URL</h2>
## 形式 ## 形式
構文1: 構文1:
@ -529,8 +515,6 @@ http://hoge.jp/abc
``` ```
## 詳細 ## 詳細
- インライン構文。
構文1のみ: 構文1のみ:
- 内容には`[.,a-z0-9_/:%#@$&?!~=+-]i`にマッチする文字を使用できる。 - 内容には`[.,a-z0-9_/:%#@$&?!~=+-]i`にマッチする文字を使用できる。
- 内容には対になっている括弧を使用できる。対象: `( )` `[ ]` - 内容には対になっている括弧を使用できる。対象: `( )` `[ ]`
@ -541,7 +525,7 @@ http://hoge.jp/abc
<h1 id="link">リンク</h2> <h1 id="link">Inline: リンク</h2>
## 形式 ## 形式
silent=false silent=false
@ -576,13 +560,12 @@ silent=true
``` ```
## 詳細 ## 詳細
- インライン構文。
- リンクラベルには再度InlineParserを適用する。 - リンクラベルには再度InlineParserを適用する。
- リンクラベルに含まれるURL、リンク、メンションはテキストとしてパースする。 - リンクラベルに含まれるURL、リンク、メンションはテキストとしてパースする。
<h1 id="emoji-code">絵文字コード(カスタム絵文字)</h2> <h1 id="emoji-code">Inline: 絵文字コード(カスタム絵文字)</h2>
## 形式 ## 形式
``` ```
@ -600,11 +583,11 @@ silent=true
``` ```
## 詳細 ## 詳細
- インライン構文。 - 内容には[a-z0-9_+-]iにマッチする文字を使用できる。
<h1 id="fn">関数</h2> <h1 id="fn">Inline: 関数</h2>
## 形式 ## 形式
構文1: 構文1:
@ -657,14 +640,13 @@ $[flip.h,v MisskeyでFediverseの世界が広がります]
``` ```
## 詳細 ## 詳細
- インライン構文
- 内容には再度InlineParserを適用する。 - 内容には再度InlineParserを適用する。
- 内容には改行も含めることが可能です。 - 内容には改行も含めることが可能です。
- 使用できる関数名やパラメータはホスト側で定義され、パーサはその登録状況を関知しません。 - 使用できる関数名やパラメータはホスト側で定義され、パーサはその登録状況を関知しません。
<h1 id="unicode-emoji">Unicode絵文字</h2> <h1 id="unicode-emoji">Inline: Unicode絵文字</h2>
## 形式 ## 形式
``` ```
@ -683,7 +665,7 @@ $[flip.h,v MisskeyでFediverseの世界が広がります]
<h1 id="text">テキスト</h2> <h1 id="text">Inline: テキスト</h2>
## 形式 ## 形式
``` ```