From 6d2a0643627dc99a04131b591b950ed0738aa4b6 Mon Sep 17 00:00:00 2001 From: marihachi Date: Thu, 30 Sep 2021 11:12:45 +0900 Subject: [PATCH] update syntax doc --- docs/syntax.md | 60 ++++++++++++++++++-------------------------------- 1 file changed, 21 insertions(+), 39 deletions(-) diff --git a/docs/syntax.md b/docs/syntax.md index 8c683f7..cddb0ff 100644 --- a/docs/syntax.md +++ b/docs/syntax.md @@ -26,7 +26,7 @@ -

引用ブロック

+

Block: 引用ブロック

## 形式 ``` @@ -46,7 +46,6 @@ ``` ## 詳細 -- ブロック構文です。 - 引用された内容には再度FullParserを適用する。 - `>`の後に続く0~1文字のスペースを無視する。 - 隣接する引用の行は一つになる。 @@ -55,7 +54,7 @@ -

検索ブロック

+

Block: 検索ブロック

## 形式 ``` @@ -77,12 +76,11 @@ MFM 書き方 [検索] ``` ## 詳細 -- ブロック構文。 - Searchの大文字小文字は区別されない。 -

コードブロック

+

Block: コードブロック

## 形式
@@ -113,12 +111,11 @@ abc
 ```
 
 ## 詳細
-- ブロック構文です。
 - langは指定されない場合はnullになる。
 
 
 
-

数式ブロック

+

Block: 数式ブロック

## 形式 ``` @@ -142,14 +139,13 @@ a = 2 ``` ## 詳細 -- ブロック構文です。 - `\[`は行頭でなければならない。 - `\]`は行末でなければならない。 - 前後のスペースと改行はトリミングされる。 -

中央寄せブロック

+

Block: 中央寄せブロック

## 形式 ``` @@ -172,7 +168,6 @@ abc ``` ## 詳細 -- ブロック構文。 - `
`は行頭でなければならない。 - `
`は行末でなければならない。 - 中身を空にすることはできない。 @@ -180,7 +175,7 @@ abc -

揺れる字

+

Inline: 揺れる字

**廃止予定の構文。代替の構文が用意されています。** ## 形式 @@ -203,13 +198,12 @@ abc ``` ## 詳細 -- インライン構文 - 内容には再度InlineParserを適用する。 - 内容には改行も含めることが可能です。 -

太字

+

Inline: 太字

## 形式 構文1: @@ -238,7 +232,6 @@ __bold__ ``` ## 詳細 -- インライン構文。 - 内容には再度InlineParserを適用する。 構文1,3のみ: @@ -249,7 +242,7 @@ __bold__ -

目立たない字

+

Inline: 目立たない字

## 形式 ``` @@ -267,13 +260,12 @@ __bold__ ``` ## 詳細 -- インライン構文です。 - 内容には再度InlineParserを適用する。 - 内容には改行も含めることが可能です。 -

イタリック

+

Inline: イタリック

## 形式 構文1: @@ -302,7 +294,6 @@ _italic_ ``` ## 詳細 -- インライン構文。 - 内容には再度InlineParserを適用する。 構文1のみ: @@ -315,7 +306,7 @@ _italic_ -

打ち消し線

+

Inline: 打ち消し線

## 形式 構文1: @@ -339,7 +330,6 @@ _italic_ ``` ## 詳細 -- インライン構文。 - 内容には再度InlineParserを適用する。 構文1のみ: @@ -350,7 +340,7 @@ _italic_ -

インラインコード

+

Inline: インラインコード

## 形式 ``` @@ -368,13 +358,12 @@ _italic_ ``` ## 詳細 -- インライン構文。 - 内容には改行を含めることができない。 - 内容には「´」を含めることができない。 -

インライン数式

+

Inline: インライン数式

## 形式 ``` @@ -392,12 +381,11 @@ _italic_ ``` ## 詳細 -- インライン構文。 - 内容には改行を含めることができない。 -

メンション

+

Inline: メンション

## 形式 ``` @@ -431,7 +419,6 @@ _italic_ ``` ## 詳細 -- インライン構文。 - 最初の`@`の前の文字が(改行、スペース、無し、[a-zA-Z0-9]に一致しない)のいずれかの場合にメンションとして認識する。 ### ユーザ名 @@ -446,7 +433,7 @@ _italic_ -

ハッシュタグ

+

Inline: ハッシュタグ

## 形式 ``` @@ -464,7 +451,6 @@ _italic_ ``` ## 詳細 -- インライン構文。 - 内容には半角スペース、全角スペース、改行、タブ文字を含めることができない。 - 内容には`.` `,` `!` `?` `'` `"` `#` `:` `/` `【` `】` `<` `>` を含めることができない。 - 括弧は対になっている時のみ内容に含めることができる。対象: `()` `[]` `「」` @@ -473,7 +459,7 @@ _italic_ -

URL

+

Inline: URL

## 形式 構文1: @@ -529,8 +515,6 @@ http://hoge.jp/abc ``` ## 詳細 -- インライン構文。 - 構文1のみ: - 内容には`[.,a-z0-9_/:%#@$&?!~=+-]i`にマッチする文字を使用できる。 - 内容には対になっている括弧を使用できる。対象: `( )` `[ ]` @@ -541,7 +525,7 @@ http://hoge.jp/abc -

リンク

+

Inline: リンク

## 形式 silent=false @@ -576,13 +560,12 @@ silent=true ``` ## 詳細 -- インライン構文。 - リンクラベルには再度InlineParserを適用する。 - リンクラベルに含まれるURL、リンク、メンションはテキストとしてパースする。 -

絵文字コード(カスタム絵文字)

+

Inline: 絵文字コード(カスタム絵文字)

## 形式 ``` @@ -600,11 +583,11 @@ silent=true ``` ## 詳細 -- インライン構文。 +- 内容には[a-z0-9_+-]iにマッチする文字を使用できる。 -

関数

+

Inline: 関数

## 形式 構文1: @@ -657,14 +640,13 @@ $[flip.h,v MisskeyでFediverseの世界が広がります] ``` ## 詳細 -- インライン構文 - 内容には再度InlineParserを適用する。 - 内容には改行も含めることが可能です。 - 使用できる関数名やパラメータはホスト側で定義され、パーサはその登録状況を関知しません。 -

Unicode絵文字

+

Inline: Unicode絵文字

## 形式 ``` @@ -683,7 +665,7 @@ $[flip.h,v MisskeyでFediverseの世界が広がります] -

テキスト

+

Inline: テキスト

## 形式 ```