コンテンツにスキップ

Markdown 基本記法

Markdown は、特殊な記号を使ってテキストを装飾するシンプルな書き方です。このページでは、基本的な記法をすべて紹介します。

見出しは文書をセクションに分けるために使います。行の先頭に # を付けます。

記法結果
# 見出し1最も大きな見出し
## 見出し22番目の見出し
### 見出し33番目の見出し
#### 見出し44番目の見出し
##### 見出し55番目の見出し
###### 見出し6最も小さな見出し

使い方: 見出しで文書を構造化すると、アウトラインパネルに見出し構造が表示され、簡単にナビゲーションできます。

記法結果用途
**太字**太字重要な語句を強調
*斜体*斜体タイトル、用語、やや控えめな強調
~~取り消し線~~取り消し線削除済み・古い情報を示す
***太字かつ斜体***太字かつ斜体特に強い強調

行の先頭に -*+ を付けます:

- 項目1
- 項目2
- ネストされた項目
- もう一つのネスト
- 項目3

数字とピリオドを付けます:

1. 最初の手順
2. 次の手順
3. 最後の手順

チェックボックス(タスクリスト)

Section titled “チェックボックス(タスクリスト)”

- [ ] で未チェック、- [x] でチェック済みの項目を作れます:

- [x] 完了したタスク
- [ ] 未完了のタスク
- [ ] もう一つのタスク
[リンクテキスト](https://example.com)
![代替テキスト](画像のパス.png)

ローカル画像には相対パス、オンライン画像には URL を使えます。

行の先頭に > を付けると引用になります:

> これは引用です。
> 複数行にまたがることもできます。

使い方: 重要な情報の強調、出典の引用、注釈に便利です。

バッククォートで囲みます:`コード`

3つのバッククォートで囲みます。言語名を指定するとシンタックスハイライトが適用されます:

```javascript
function hello() {
console.log("Hello, world!");
}
```

Bokuchi は 190 以上のプログラミング言語のシンタックスハイライトに対応しています。

パイプ | とダッシュ - で表を作成します:

| 名前 | 役割 | 状態 |
|---------|----------|--------|
| Alice | デザイナー | 在籍 |
| Bob | エンジニア | 在籍 |

3つ以上のダッシュで区切り線を作成します:

---

設定 > 詳細設定 > レンダリング拡張 で KaTeX を有効にすると、数式をレンダリングできます。

インライン数式 — 単一のドル記号で囲みます:

公式 $E = mc^2$ はよく知られています。

ブロック数式 — 二重のドル記号で囲みます:

$$
\sum_{i=1}^{n} x_i
$$

設定 > 詳細設定 > レンダリング拡張 で Mermaid を有効にすると、```mermaid コードブロックで図表を作成できます。

```mermaid
graph TD
A[開始] --> B{判定}
B -->|はい| C[結果A]
B -->|いいえ| D[結果B]
```

フローチャート、シーケンス図、クラス図、状態遷移図など、さまざまな図表に対応しています。

テキストエフェクト(Bokuchi 独自機能)

Section titled “テキストエフェクト(Bokuchi 独自機能)”

Bokuchi のプレビューでは、特殊な視覚効果を適用できます。:::エフェクト名::: でコンテンツを囲みます:

:::rainbow
このテキストが虹色に表示されます。
:::

使用可能なエフェクト:

エフェクト説明
shakeテキストが左右に揺れます
rainbowテキストが虹色に変化します
glowテキストが光るように明滅します
bounceテキストが上下にバウンスします
blinkテキストが点滅します
rainbow テキストエフェクトがプレビューに表示されている様子