Markdown

本書執筆者が知っておくべきMarkdownの使い方を説明します。

Frontmatter#

ページのメタ情報や設定をfrontmatterに書くことができます。frontmatterはYAML形式です。

---slug: /reference/function---

利用可能な設定は次のものがあります。

キー	型	説明	デフォルト値
`sidebar_label`	`string`	サイドバーや前後ページナビゲーション、サイト内リンクブロックに表示されるページタイトル	最初の見出しの内容
`slug`	`string`	ページのURLのパス部分	ファイル名
`tags`	`string[]`	ページのタグ	`[]`
`description`	`string`	ページの要約。`<meta name="description" content="..."/>`やサイト内リンクブロックの説明として使われる。	最初の段落の内容

---sidebar_label: アロー関数slug: /reference/functions/arrow-functiontags:  - 関数  - アロー関数description: TypeScriptでアロー関数を定義する方法---

見出し#

見出しレベル1#は、ページタイトルにのみ使います。
ページ内のセクションは見出しレベル2##以上を使います。

例

# ページタイトル
...序文...
## 大見出し
...
### 中見出し
...

リンク#

サイト内リンクはMarkdownファイルパスを相対パスで書きます。

詳細は[関数](../references/functions.md)をご覧ください。

内部リンクブロック#

内部リンクブロックは、サイト内のページへのリンクを表示するためのものです。次の例のように、ページタイトルと説明文が自動的に表示されるコンポーネントです。

内部リンクブロックには次の利点があります。

関連ページが目立つ
リンク先ページのタイトル変更に自動的に追従できる

リンクブロックを作るには、前後に空白行を置き、かつ、サイト内リンクの行の前後には何も文字を書かないようにします。

...テキスト...
[letとconst](../references/values-types-variables/let-and-const.md)
...テキスト...

caution

Markdownのリンクテキストは無視され、リンク先のタイトルが採用されます。たとえば、function.mdのタイトルが「関数について」で、Markdownが[ファンクション](./function.md)のとき、「ファンクション」は無視され、ウェブサイト上の表示は「関数について」が採用されます。

インラインコード#

インラインコードの前後には空白を置かないようにします。

❌ 変数宣言は `const` を用います。⭕️ 変数宣言は`const`を用います。

インラインコードでバッククォートを使うには、ダブルバッククォートを使います。

テンプレートリテラルは`` ` ``を使います。

テンプレートリテラルは`を使います。

コードブロック#

コードブロックは言語名を適切に指定します。

```typescript// code```

使用可能な言語は次のとおりです。

Prisimでデフォルトで有効になっているもの
docusaurus.config.jsのadditionalLanguagesで追加で有効にしたもの
- 必要に応じて追加できます。

コードブロックのタイトル#

コードブロックにタイトルをつけるにはtitle属性を指定します。

```typescript title="sample.ts"// sample code```

sample.ts

// sample code

行番号#

4行以上あるコードブロックは行番号が自動で付与されます。

1行目2行目3行目

1行目2行目3行目4行目

サンプルコードの自動整形#

コードブロックはPrettierで自動整形されます。

自動整形をされたくないコードブロック場合は、を直前に書きます。

```typescriptf = x => x;```
<!--prettier-ignore-->```typescriptf = x => x;```

整形結果

```typescriptf = (x) => x;```
<!--prettier-ignore-->```typescriptf = x => x;```

警告表示#

トリプルコロン:::で囲んだテキストは警告表示にできます。

:::noteテキスト:::
:::tipテキスト:::
:::infoテキスト:::
:::cautionテキスト:::
:::dangerテキスト:::

note

テキスト

tip

テキスト

info

テキスト

caution

テキスト

danger

テキスト

警告表示にはタイトルを指定できます。

:::note 好みのタイトルテキスト:::

好みのタイトル

テキスト