快速开始

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

---

下一步

• 了解如何编写更丰富的文档内容，请阅读写作指南。
• 准备将文档上线？请阅读部署发布。