sfm-js/docs/syntax.md

目次

ブロック構文:

• 引用ブロック
• 検索ブロック
• コードブロック
• 数式ブロック
• 中央寄せブロック

インライン構文:

構文	改行可能？
揺れる字	はい
太字	はい
目立たない字	はい
イタリック	はい
打ち消し線	いいえ
インラインコード	いいえ
インライン数式	いいえ
メンション	いいえ
ハッシュタグ	いいえ
URL	いいえ
リンク	いいえ
絵文字コード(カスタム絵文字)	いいえ
MFM関数	はい
Unicode絵文字	いいえ
テキスト	はい

引用ブロック

形式

> abc
>abc
>>nest

ノード

{
  type: 'quote',
  children: [
    { type: 'text', props: { text: 'abc' } }
  ]
}

詳細

• ブロック構文です。
• 引用された内容には再度FullParserを適用する。
• >の後に続く0～1文字のスペースを無視する。
• 隣接する引用の行は一つになる。
• 複数行の引用では空行も含めることができる。
• 引用の後ろにある空行は無視される。(issue #61)

検索ブロック

形式

MFM 書き方 Search
MFM 書き方 検索
MFM 書き方 [Search]
MFM 書き方 [検索]

ノード

{
  type: 'search',
  props: {
    query: 'MFM 書き方',
    content: 'MFM 書き方 Search'
  }
}

詳細

• ブロック構文。
• Searchの大文字小文字は区別されない。

コードブロック

形式

```
a

b```
```c
````
```

```js
abc
````

ノード

{
  type: 'blockCode',
  props: {
    code: 'abc',
    lang: 'js'
  }
}

詳細

• ブロック構文です。
• langは指定されない場合はnullになる。

数式ブロック

形式

\[a = 1\]

\[
a = 2
\]

ノード

{
  type: 'mathBlock',
  props: {
    formula: 'a = 1'
  }
}

詳細

• ブロック構文です。
• \[は行頭でなければならない。
• \]は行末でなければならない。
• 前後のスペースと改行はトリミングされる。

中央寄せブロック

形式

<center>abc</center>

<center>
abc
</center>

ノード

{
  type: 'center',
  children: [
    { type: 'text', props: { text: 'abc' } }
  ]
}

詳細

• ブロック構文。
• <center>は行頭でなければならない。
• </center>は行末でなければならない。
• 中身を空にすることはできない。
• 内容には再度InlineParserを適用する。

揺れる字

廃止予定の構文。代替の構文が用意されています。

形式

***big!***

ノード

{
  type: 'fn',
  props: {
    name: 'tada',
    args: { }
  },
  children: [
    { type: 'text', props: { text: 'big!' } }
  ]
}

詳細

• インライン構文
• 内容には再度InlineParserを適用する。
• 内容には改行も含めることが可能です。

太字

形式

**bold**

__bold__

ノード

{
  type: 'bold',
  children: [
    { type: 'text', props: { text: 'bold' } }
  ]
}

詳細

• インライン構文。
• 内容には再度InlineParserを適用する。
• 内容には改行も含めることが可能です。

目立たない字

形式

<small>small</small>

ノード

{
  type: 'small',
  children: [
    { type: 'text', props: { text: 'small' } }
  ]
}

詳細

• インライン構文です。
• 内容には再度InlineParserを適用する。
• 内容には改行も含めることが可能です。

イタリック

形式

構文1:

<i>italic</i>

構文2:

*italic*

構文3:

_italic_

ノード

{
  type: 'italic',
  children: [
    { type: 'text', props: { text: 'italic' } }
  ]
}

詳細

• インライン構文。
• 内容には再度InlineParserを適用する。

構文1のみ:

• 内容には改行も含めることが可能です。

構文2,3のみ:
※1つ目の*と_を開始記号と呼ぶ。

• 内容には[a-z0-9 \t]iにマッチする文字が使用できる。
• 開始記号の前の文字が(無い、改行、半角スペース、[a-zA-Z0-9]に一致しない)のいずれかの時にイタリック文字として判定される。

打ち消し線

形式

~~strike~~

ノード

{
  type: 'strike',
  children: [
    { type: 'text', props: { text: 'strike' } }
  ]
}

詳細

• インライン構文。
• 内容には再度InlineParserを適用する。
• 内容には改行を含めることができない。
• 内容には~を含めることができない。

インラインコード

形式

`$abc <- 1`

ノード

{
  type: 'inlineCode',
  props: {
    code: '$abc <- 1'
  }
}

詳細

• インライン構文。
• 内容には改行を含めることができない。
• 内容には「´」を含めることができない。

インライン数式

形式

\(y = 2x\)

ノード

{
  type: 'mathInline',
  props: {
    formula: 'y = 2x'
  }
}

詳細

• インライン構文。
• 内容には改行を含めることができない。

メンション

形式

@user@misskey.io

@user

ノード

{
  type: 'mention',
  props: {
    username: 'user',
    host: 'misskey.io',
    acct: '@user@misskey.io'
  }
}

{
  type: 'mention',
  props: {
    username: 'user',
    host: null,
    acct: '@user'
  }
}

詳細

• インライン構文。
• 最初の@の前の文字が(改行、スペース、無し、[a-zA-Z0-9]に一致しない)のいずれかの場合にメンションとして認識する。

ユーザ名

• 1文字以上。
• A～Z 0～9 _ -が含められる。
• 1文字目と最後の文字は-にできない。

ホスト名

• 1文字以上。
• A～Z 0～9 _ - .が含められる。
• 1文字目と最後の文字は- .にできない。

ハッシュタグ

形式

#abc

ノード

{
  type: 'hashtag',
  props: {
    hashtag: 'abc'
  }
}

詳細

• インライン構文。
• 内容には半角スペース、全角スペース、改行、タブ文字を含めることができない。
• 内容には. , ! ? ' " # : / 【 】 を含めることができない。
• 括弧は対になっている時のみ内容に含めることができる。対象: () [] 「」
• #の前の文字が(改行、スペース、無し、[a-zA-Z0-9]に一致しない)のいずれかの場合にハッシュタグとして認識する。
• 内容が数字のみの場合はハッシュタグとして認識しない。

URL

形式

構文1:

https://misskey.io/@ai

http://hoge.jp/abc

構文2:

<https://misskey.io/@ai>

<http://藍.jp/abc>

ノード

{
  type: 'url',
  props: {
    url: 'https://misskey.io/@ai'
  }
}

詳細

• インライン構文。

構文1のみ:

• 内容には[.,a-z0-9_/:%#@$&?!~=+-]iにマッチする文字を使用できる。
• 内容には対になっている括弧を使用できる。対象: ( ) [ ]
• .や,は最後の文字にできない。

構文2のみ:

• 内容には改行、スペース以外の文字を使用できる。

リンク

形式

silent=false

[Misskey.io](https://misskey.io/)

silent=true

?[Misskey.io](https://misskey.io/)

ノード

[
  {
    type: 'link',
    props: {
      silent: false,
      url: 'https://misskey.io/'
    },
    children: [
      {
        type: 'text',
        props: {
          text: 'Misskey.io'
        }
      }
    ]
  }
]

詳細

• インライン構文。
• 内容には再度InlineParserを適用する。
• 内容に含まれるURLはテキストとしてパースする。

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

形式

:thinking_ai:

ノード

{
  type: 'emojiCode',
  props: {
    name: 'thinking_ai'
  }
}

詳細

• インライン構文。

関数

形式

構文1:

$[shake 🍮]

$[spin.alternate 🍮]

$[shake.speed=1s 🍮]

$[flip.h,v MisskeyでFediverseの世界が広がります]

構文2: 廃止予定の構文。代替の構文(構文1)が用意されています。

[shake 🍮]

[spin.alternate 🍮]

[shake.speed=1s 🍮]

[flip.h,v MisskeyでFediverseの世界が広がります]

ノード

{
  type: 'fn',
  props: {
    name: 'shake',
    args: { }
  },
  children: [
    { type: 'unicodeEmoji', props: { emoji: '👍' } }
  ]
}

詳細

• インライン構文
• 内容には再度InlineParserを適用する。
• 内容には改行も含めることが可能です。
• 使用できる関数名やパラメータはホスト側で定義され、パーサはその登録状況を関知しません。

Unicode絵文字

形式

😇

ノード

{
  type: 'unicodeEmoji',
  props: {
    emoji: '😇'
  }
}

テキスト

形式

abc

ノード

{
  type: 'text',
  props: 
    text: 'abc'
  }
}