--- title: Markdown 記法ガイド tags: - manual content_id: 01KN2BNMMADN2P5Q3B0E5MNTZE visibility: public --- # Markdown 記法ガイド ## Markdown とは Markdown は、テキストに簡単な記号をつけて見出しやリンクなどの書式を表現する記法です。特別なエディタは不要で、プレーンテキストとして読み書きできます。 ## 基本の書式 ### 見出し `#` の数で見出しのレベルが変わります。 ``` # 大見出し ## 中見出し ### 小見出し ``` ### テキストの装飾 ``` **太字** *斜体* ~~打ち消し線~~ `インラインコード` ``` ### リスト ``` - 箇条書き - 箇条書き - ネストもできます 1. 番号付きリスト 2. 番号付きリスト ``` ### リンクと画像 ``` [表示テキスト](https://example.com) ![代替テキスト](画像のURL) ``` ### 引用 ``` > 引用文 ``` ### コードブロック バッククォート3つで囲みます。言語名を指定するとシンタックスハイライトが付きます。 ```` ```js console.log('hello') ``` ```` ### 改行 行末でそのまま改行すると、表示上も改行されます（一般的な Markdown とは異なり、空行を挟む必要はありません）。 --- ## このサイト独自の記法 ### Wikilink `[[` と `]]` でページ名を囲むと、サイト内のページへのリンクになります。エディタ内で `[[` を入力するとページ名の補完が効きます。 ``` [[ページ名]] → ページへのリンク [[ページ名|表示名]] → 別の表示名でリンク [[ページ名#icon]] → そのページのアイコンを表示 ``` ### 数式（LaTeX） `$` で囲むとインライン数式、`$$` で囲むとブロック数式になります。 ``` インライン: $E = mc^2$ ブロック: $$ \int_0^\infty e^{-x}\,dx = 1 $$ ``` ### 定義リスト 用語の次の行に `: ` で始まる定義を書きます。 ``` 用語 : その説明文 ``` ### URL の自動埋め込み 段落に URL だけを書くと、対応するサービスはプレーヤーやカードとして自動で埋め込まれます。 対応サービス: YouTube, Vimeo, X (Twitter), Instagram ### 特殊ブロック `::ブロック名` と `::` で囲むことで、特殊な表示ブロックを使えます。 #### 多言語 閲覧者の言語に応じて表示を切り替えます。 ``` ::ja 日本語の本文 :: ::en English text :: ``` #### 折りたたみ（スポイラー） クリックするまで中身が隠されるブロックです。 ``` ::spoiler[クリックで開く] 隠されている内容 :: ``` #### メンバー限定 メンバーにだけ表示されるブロックです。 ``` ::gated メンバー限定コンテンツ :: ``` #### 管理者限定 管理者にだけ表示されるブロックです。管理者以外には何も表示されず、メンバー限定コンテンツとしても扱われません。 ``` ::AdminOnly 管理者だけに見せたい内容 :: ``` #### 補足・警告 ``` ::note 補足情報 :: ::warning 注意事項 :: ::caution 危険・重大な注意 :: ``` #### 図表・メディア ``` ::mermaid graph LR; A-->B :: ::video-loop{src="/path/to/video.mp4"} :: ::hero ヒーロー画像やテキスト :: ::credits クレジット表記 :: ``` #### ページ一覧の埋め込み サイト内のページを条件で絞り込んで一覧表示します。 ``` ::data-view{query="タグ名" sort-by="date" sort-order="desc" view="card"} :: ``` #### インラインの特殊記法 ``` :icon[search] → アイコン表示 :big[大きな文字] → 大きな文字 :count{words}[対象テキスト] → 語数カウント表示 ``` --- ## フロントマターとは 各ページの冒頭に `---` で囲んで書く設定欄です。タイトルや公開設定など、本文以外のページ情報をここに記述します。多くは自動で管理されますが、手動で編集することもできます。 ```yaml --- content_id: 01J5K... visibility: public date: 2025-01-01 tags: [日記] --- ``` ### 基本情報 | フィールド | 説明 | |-----------|------| | `content_id` | ページ固有の ID（自動生成。変更しないでください） | | `title` | ページタイトル。省略すると本文の `# 見出し` が使われます | | `title_locale` | 言語別のタイトル上書き（例: `{en: "Hello", ja: "こんにちは"}`） | | `short_title` | 一覧表示などで使われる短いタイトル | | `hide_title` | `true` にすると記事上部の見出し表示を省略します | | `hide_date` | `true` にすると日付の表示を省略します | | `hide_updated` | `true` にすると更新日の表示を省略します | | `hide_toc` | `true` にすると目次の表示を省略します | | `description` | ページの説明文。SNS 共有時などに使われます | | `aliases` | ページの別名。検索や Wikilink で使えます（例: `[別名1, 別名2]`） | | `tags` | タグ（例: `[日記, メモ]`） | ### 日時 | フィールド | 説明 | |-----------|------| | `date` | ページの代表日時。イベント開始日や公開日（例: `2025-01-01`） | | `until` | 期間ものイベントの終了日時。未設定なら `date` と同じ扱い | | `updated` | 訪問者向けの更新日時。ソートや RSS で使われます | ### 公開設定 | フィールド | 説明 | |-----------|------| | `visibility` | `public`（公開）/ `unlisted`（限定公開）/ `private`（非公開）/ `contextual`（サイト内遷移経由でのみ閲覧可） | | `redirect` | 指定した URL やページパスへリダイレクトします | ### 表示 | フィールド | 説明 | |-----------|------| | `thumbnail` | サムネイル画像のパス | | `thumbnail_list` | 一覧表示で優先されるサムネイル画像のパス | | `icon` | ページのアイコン画像のパス。`[[ページ名#icon]]` で表示されます | | `layout` | `page`（通常）/ `full`（全幅表示） | | `draft` | `true` にすると下書き扱いになり、noindex/nofollow が強制され `` に `draft` クラスが付きます。`visibility` とは独立に効くので、`draft` でも `public`/`unlisted` ならアクセスは可能 | ### サイト全体の設定（index ページのみ） index ページのフロントマターでは、サイト全体に影響する設定も記述できます。 | フィールド | 説明 | |-----------|------| | `site_title` | サイト名 | | `site_logo` | サイトロゴ画像のパス | | `favicon` | ファビコンのパス | | `menu` | ヘッダーメニュー | | `footer_menu` | フッターメニュー | | `footer_text` | フッターに表示するテキスト | | `author` | サイトの著者ページのスラッグ。`⌘⇧I` で挿入されるアイコンに使われます | | `theme` | サイトの色・フォントなどのカスタマイズ | | `admin_users` | 管理者ユーザーの一覧 | | `member_users` | メンバーユーザーの一覧 |