JavaGuide 文档系统是支持 JavaGuide 网站（https://javaguide.cn/）的全面结构。它基于 VuePress 2.0，一个 Vue 驱动的静态站点生成器，并使用了 VuePress Hope 主题以增强功能。本文档解释了内容的组织方式、网站的配置以及如何为文档贡献内容。
有关 JavaGuide 项目本身的信息，请参阅 JavaGuide 概述。
JavaGuide 文档系统将 Markdown 内容转换为结构良好的技术网站。它支持搜索功能、响应式设计、侧边栏导航和自定义主题等各种功能。
来源：docs/.vuepress/config.ts docs/.vuepress/theme.ts package.json
文档被组织成 VuePress 用于生成最终网站的特定目录结构。
来源：docs/.vuepress/sidebar/index.ts docs/.vuepress/config.ts README.md
| 文件/目录 | 目的 |
|---|---|
docs/ | 所有内容根目录 |
docs/.vuepress/ | VuePress 的配置目录 |
docs/.vuepress/config.ts | VuePress 的主配置文件 |
docs/.vuepress/theme.ts | 主题配置文件 |
docs/.vuepress/sidebar/ | 侧边栏配置文件 |
docs/README.md | 首页内容 |
docs/home.md | 显示所有可用内容的主内容页 |
| 内容目录 (java/, database/, 等) | 特定主题内容 |
来源：docs/.vuepress/config.ts docs/.vuepress/theme.ts docs/.vuepress/sidebar/index.ts
配置系统由几个 TypeScript 文件组成，它们定义了站点的构建、样式和导航方式。
config.ts 文件定义了核心站点设置，例如：
主题配置定义了站点的视觉外观和布局
侧边栏导航是文档系统中最重要的部分之一，它将内容组织成一个分层结构，便于导航。
来源：docs/.vuepress/sidebar/index.ts
侧边栏使用 TypeScript 配置，具有反映内容组织的嵌套结构。每个条目可以定义
来源：docs/.vuepress/sidebar/index.ts
JavaGuide 中的内容主要以 Markdown 文件形式编写，并组织成层级目录结构。每个 Markdown 文件通常遵循标准格式，顶部包含 frontmatter 元数据。
Markdown 文件使用 YAML frontmatter 来定义页面元数据。
来源：docs/database/redis/redis-skiplist.md docs/java/basis/syntactic-sugar.md
内容按主要主题领域组织，每个主题都有自己的目录和子目录。
| 目录 | 目的 |
|---|---|
java/ | Java 编程语言主题 |
cs-basics/ | 计算机科学基础 |
database/ | 数据库系统和技术 |
system-design/ | 系统设计原则和模式 |
distributed-system/ | 分布式系统概念 |
high-performance/ | 高性能计算主题 |
high-availability/ | 高可用系统设计 |
文档系统使用 pnpm 作为包管理器，并包含用于开发、构建和 linting 的脚本。
来源：package.json
package.json 文件定义了各种任务的脚本：
来源：package.json
文档系统使用各种插件来增强功能。
搜索插件允许用户搜索文档内容。
博客插件为文档添加了博客功能。
Feed 插件为内容更新生成 RSS、Atom 和 JSON Feed。
版权插件为内容添加版权信息。
VuePress 使用各种增强功能处理 Markdown 内容。
主题配置启用了多个 Markdown 增强功能。
JavaGuide 文档系统是一个基于 VuePress 构建的全面解决方案，它将 Markdown 内容转换为组织良好、可搜索的技术网站。该系统的配置允许灵活的内容组织、丰富的格式化以及搜索和博客功能等增强功能。
内容（Markdown 文件）与配置（TypeScript 文件）的分离使得维护和更新文档变得容易，而分层目录结构确保了内容的逻辑组织和易于导航。
对于希望为 JavaGuide 做出贡献的人来说，理解这个文档系统对于创建与现有结构无缝集成的内容至关重要。