文書の追加方法
新しい文書の追加
Section titled “新しい文書の追加”新しい文書を追加するには、適切なカテゴリのディレクトリに新しいMarkdownファイルを作成します。
ディレクトリ構造
Section titled “ディレクトリ構造”src/content/docs/├── guides/ # ガイド├── policy/ # 規程・方針├── procedure/ # 手順書├── guideline/ # ガイドライン└── record/ # 記録・帳票フロントマターの設定
Section titled “フロントマターの設定”各文書ファイルの先頭には、以下のフロントマターを記述します:
---title: 文書のタイトルdescription: 文書の簡単な説明author: 作成者名pubDate: 2024-01-22updatedDate: 2024-01-22---
# 文書の内容
ここに文書の本文を記述します。フロントマターフィールド
Section titled “フロントマターフィールド”| フィールド | 必須 | 説明 |
|---|---|---|
title | ✅ | 文書のタイトル |
description | ✅ | 文書の説明(検索結果に表示) |
version | ❌ | バージョン番号(例: “1.0”) |
author | ❌ | 作成者名 |
pubDate | ❌ | 公開日(YYYY-MM-DD形式) |
updatedDate | ❌ | 更新日(YYYY-MM-DD形式) |
Markdown記法
Section titled “Markdown記法”# 見出し1## 見出し2### 見出し3- 箇条書き1- 箇条書き2 - ネストした項目
1. 番号付きリスト12. 番号付きリスト2| 列1 | 列2 | 列3 ||-----|-----|-----|| データ1 | データ2 | データ3 |コードブロック
Section titled “コードブロック”```pythondef hello(): print("Hello, World!")```Starlightの組み込みコンポーネントを使用できます:
:::noteこれは注意書きです。:::
:::tipこれはヒントです。:::
:::cautionこれは警告です。:::
:::dangerこれは危険な操作についての警告です。:::ファイル名の規則
Section titled “ファイル名の規則”- ファイル名は英数字とハイフンを使用
- 日本語は避ける
- 例:
information-security-policy.md
- 開発サーバーを起動:
pnpm dev - ブラウザで http://localhost:4321/ にアクセス
- サイドバーから追加した文書を確認