クイックスタート

TechHub 技術ナレッジベースへようこそ！このガイドでは、プロジェクト構造の把握、ローカル開発環境の起動、そして初版ドキュメントの公開までを素早く行えるようにします。

環境要件

• Node.js 18 以上
• npm / pnpm / yarn いずれかのパッケージマネージャー

依存関係のインストール

npm install

開発サーバーの起動

npm run docs:dev

起動後、http://localhost:5173 にアクセスし、任意の Markdown ファイルを編集するとリアルタイムでホットリロードされプレビューされます。

ディレクトリ構造

.
├── docs/
│   ├── .vitepress/          # VitePress 配置与主题
│   │   ├── config.mjs       # 站点全局配置（导航/侧边栏/搜索等）
│   │   └── theme/           # 主题定制（样式、组件）
│   ├── public/              # 静态资源（图片、favicon 等）
│   ├── index.md             # 首页
│   ├── project/             # 本站项目自身文档
│   ├── frontend/            # 前端技术
│   ├── backend/             # 后端技术
│   ├── languages/           # 编程语言
│   ├── ai/                  # AI 方向
│   ├── paths/               # 学习路径
│   ├── journals/            # 过程记录（日志/踩坑/复盘）
│   ├── books/               # 读书笔记
│   └── papers/              # 文献收藏
├── scripts/                 # 部署/回滚/更新日志脚本
├── package.json
└── README.md

ドキュメントの追加

1. 該当ディレクトリに .md ファイルを作成します。例：docs/guide/example.md；
2. ファイル先頭に Frontmatter メタ情報を記述します：

---
title: 示例文档
description: 本文档用于演示基础用法。
---

# 示例文档

这里是正文内容。

3. ページをサイドバーに追加します（docs/.vitepress/config.mjs の sidebar 設定を編集）。

静的サイトのビルド

npm run docs:build

ビルド成果物は docs/.vitepress/dist に出力され、任意の静的サーバーや CDN にホスティングできます。

ビルド結果のローカルプレビュー

npm run docs:preview

---

次のステップ

• よりリッチなドキュメントの書き方については、執筆ガイド をお読みください。
• ドキュメントを公開する準備はできましたか？デプロイと公開 をお読みください。