このページは snsn-codex の基本機能 をひととおり使うサンプルです。
各セクションをコピー&ペーストして、自分のページのベースにしてください。
ページの書き方(frontmatter)
src/content/wiki/ に .md または .mdx ファイルを置くだけでページになります。
ファイルの先頭に --- で囲んだ frontmatter を書いてメタデータを設定します。
---
title: "ページタイトル" # 必須:ページのタイトル
description: "短い説明文" # 任意:検索結果・メタタグに使用
tags: ["タグ1", "タグ2"] # 任意:タグ(配列)
category: "カテゴリ名" # 任意:サイドバー自動収集のキー
aliases: ["別名", "旧タイトル"] # 任意:WikiLinkの名前解決に使う別名
date: 2026-01-01 # 任意:作成日
updated: 2026-06-01 # 任意:更新日(「最近の更新」に影響)
draft: false # 任意:true にすると非公開(ビルドから除外)
hideBacklinks: true # 任意:true にするとバックリンク欄を非表示
---
frontmatter フィールド一覧
| フィールド | 型 | 説明 |
|---|---|---|
title | string | 必須。 ページタイトル |
description | string | 短い説明文(検索・OGP用) |
tags | string[] | タグの配列 |
category | string | カテゴリ名(サイドバー自動収集のキー) |
aliases | string[] | WikiLink で解決できる別名 |
date | date | 作成日 (YYYY-MM-DD) |
updated | date | 更新日 (YYYY-MM-DD) |
draft | bool | true で下書き(ビルドから除外) |
hideBacklinks | bool | true でバックリンク欄を非表示 |
template | bool | true でページ一覧・サイドバー・グラフ・検索から除外(URL は存在する) |
WikiLink でページをつなぐ
[[ページ名]] と書くとリンクになります。
- 通常リンク → 入門
- テキスト指定 → セットアップガイドを読む
- 存在しないページ → まだ書いていないページ (赤リンクで表示)
ページ下部の バックリンク 欄には、このページへリンクしているページが自動的に一覧表示されます。
コールアウト(ボックス)
ノートボックスです。補足情報や注意書きに使います。
ヒントボックスです。推奨の手順やベストプラクティスに使います。
警告ボックスです。見落としやすい注意点に使います。
危険ボックスです。データ消失・不可逆な操作の前に使います。
バッジ
ステータスや分類をインラインで示せます:
完了 進行中 未着手 重要 アーカイブ 実験的infobox(情報ボックス)
ページの概要を右寄せのボックスでまとめられます。fields プロパティにラベルと値の配列を渡します。
details(折り畳み)
クリックして展開
折り畳まれたコンテンツです。補足情報や長い説明を隠しておくのに使います。
- Markdown もそのまま書けます
- 太字・
コード・リストもOK
脚注
重要な補足は脚注として末尾に追記できます [1] 。
複数の脚注 [2] を組み合わせることもできます。
番号にホバーするとポップアップ表示、クリックすると末尾にスクロールします。
テーブル
| 機能 | 説明 | 難易度 |
|---|---|---|
| WikiLink | [[ページ名]] でページ間リンク | ★☆☆ |
| コールアウト | note / tip / warning / danger ボックス | ★☆☆ |
| バッジ | インラインのカラーラベル | ★☆☆ |
| infobox | 右寄せの情報まとめボックス | ★☆☆ |
| タブ | Tabs / Tab コンポーネントでタブ切り替え | ★★☆ |
| トランスクルージョン | Include で他ページを埋め込み | ★★☆ |
| データテーブル | Datatable で JSON 連携テーブル | ★★★ |
コード
インラインコード: const wiki = new Wiki()
コードブロック:
// src/content/wiki/my-page.mdx に配置するだけでページになります
const page = await getEntry('wiki', 'my-page');
console.log(page.data.title); // "My Page"
数式
インライン数式:
ブロック数式:
Mermaid ダイアグラム
graph TD
A[Start] --> B{Condition}
B -->|Yes| C[Action 1]
B -->|No| D[Action 2]
C --> E[End]
D --> E
sequenceDiagram
Editor->>+codex: ファイル保存
codex->>+Astro: ビルドトリガー
Astro-->>-codex: 静的HTML生成
codex-->>-Editor: プレビュー更新
関連ページ
- 入門 — セットアップと基本的な使い方
- サンプル:ショートコードリファレンス — 全ショートコードの一覧
- サンプル:高度な機能 — タブ・埋め込み・Navbox の動作確認
注釈
[1] 脚注テキストはここに書きます。本文中の番号にホバーするとポップアップで表示されます。 ↩
[2] 複数の脚注を並べられます。「↩」で参照元に戻れます。 ↩