コンテンツにスキップ

文書の追加方法

新しい文書を追加するには、適切なカテゴリのディレクトリに新しいMarkdownファイルを作成します。

src/content/docs/
├── guides/ # ガイド
├── policy/ # 規程・方針
├── procedure/ # 手順書
├── guideline/ # ガイドライン
└── record/ # 記録・帳票

各文書ファイルの先頭には、以下のフロントマターを記述します:

---
title: 文書のタイトル
description: 文書の簡単な説明
author: 作成者名
pubDate: 2024-01-22
updatedDate: 2024-01-22
---
# 文書の内容
ここに文書の本文を記述します。
フィールド必須説明
title文書のタイトル
description文書の説明(検索結果に表示)
versionバージョン番号(例: “1.0”)
author作成者名
pubDate公開日(YYYY-MM-DD形式)
updatedDate更新日(YYYY-MM-DD形式)
# 見出し1
## 見出し2
### 見出し3
- 箇条書き1
- 箇条書き2
- ネストした項目
1. 番号付きリスト1
2. 番号付きリスト2
| 列1 | 列2 | 列3 |
|-----|-----|-----|
| データ1 | データ2 | データ3 |
```python
def hello():
print("Hello, World!")
```

Starlightの組み込みコンポーネントを使用できます:

:::note
これは注意書きです。
:::
:::tip
これはヒントです。
:::
:::caution
これは警告です。
:::
:::danger
これは危険な操作についての警告です。
:::
  • ファイル名は英数字とハイフンを使用
  • 日本語は避ける
  • 例: information-security-policy.md
  1. 開発サーバーを起動: pnpm dev
  2. ブラウザで http://localhost:4321/ にアクセス
  3. サイドバーから追加した文書を確認