快速開始

歡迎使用 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

---

下一步

• 了解如何編寫更豐富的文件內容，請閱讀寫作指南。
• 準備將文件上線？請閱讀部署發布。