執筆ガイド
本サイトのドキュメントは Markdown で記述され、Frontmatter、ヒントブロック、コードハイライト、数式などの拡張構文に対応しています。
Frontmatter
ファイル先頭で YAML によりページのメタ情報を宣言します:
md
---
title: 页面标题
description: 页面描述(用于 SEO)
tags:
- 指南
- Markdown
---
# 正文标题よく使うフィールド:
| フィールド | 説明 |
|---|---|
title | ページタイトル。ナビゲーションバーの表示を上書きします |
description | ページの説明。検索エンジンと共有カードに使われます |
tags | ページのタグ |
layout | ページレイアウト。デフォルトは doc、ホームページは home |
outline | 右側の目次を表示するかどうか |
ヒントブロック
md
:::: tip 提示
这是一条提示信息。
::::
:::: warning 注意
这是一条警告信息。
::::
:::: danger 危险
这是一条危险信息。
::::
:::: info 说明
这是一条普通说明。
::::効果プレビュー:
提示
这是一条提示信息。
注意
这是一条警告信息。
危险
这是一条危险信息。
说明
这是一条普通说明。
コードブロック
js、ts、bash、python、json、sql など一般的な言語のシンタックスハイライトに対応し、行番号の表示や指定行のハイライトも可能です:
md
```js {2,4-5}
function greet(name) {
const message = `Hello, ${name}!` // 高亮行
console.log(message)
return message
}
```js
function greet(name) {
const message = `Hello, ${name}!` // 高亮行
console.log(message)
return message
}数式
KaTeX を使用して数式をレンダリングします:
md
行内公式 $E = mc^2$
块级公式:
$$
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
$$テーブル
md
| 方法 | 路径 | 说明 |
| --- | --- | --- |
| GET | `/api/users` | 获取用户列表 |
| POST | `/api/users` | 创建用户 |
| DELETE | `/api/users/:id` | 删除用户 |画像とリンク
md

[跳转到快速开始](./getting-started)コンポーネント拡張
VitePress は Markdown 内で Vue コンポーネントを直接使用でき、複雑なインタラクション(チャート、デモ、タブなど)をコンポーネントとしてカプセル化して再利用できます。
執筆のアドバイス
- 各ドキュメントは 1 つのテーマに焦点を当て、明確な見出し階層(
#→##→###)を使う; - コード例は必ずそのまま実行可能にし、必要なコメントを含める;
- ヒントブロックで注意点や境界ケースを強調する;
- 関連ドキュメント同士は相対リンクで相互に移動する。