Skip to content

站点框架配置草案

本目录用于把当前仓库里的“中立导航配置”进一步映射到具体文档站框架。 如果说:

  • 侧边栏 是人类可读的信息架构草案
  • docs/site-navigation.json 是框架无关的机器可读导航源

那么这里的文件就是“可直接抄过去改”的站点框架配置草案。

当前内容

  • docs/.vitepress/config.ts:VitePress 站点入口配置

  • docs/.vitepress/theme/index.ts:VitePress 主题入口

  • docs/.vitepress/theme/custom.css:基础站点样式覆盖

  • docs/site-configs/docusaurus-sidebars.js:Docusaurus 侧边栏配置草案

  • docs/site-configs/docusaurus-navbar.json:Docusaurus 顶部导航配置草案

  • docs/site-configs/vitepress-theme-config.ts:VitePress nav/sidebar 配置草案

  • docs/site-configs/github-pages-workflow.yml.example:GitHub Pages workflow 示例

  • GitHub Pages部署笔记:GitHub Pages 配套说明

  • docs/site-configs/vercel.json.example:Vercel 构建配置示例

  • docs/site-configs/netlify.toml.example:Netlify 构建配置示例

使用建议

如果你后续接 Docusaurus

  1. 先参考 docs/site-configs/docusaurus-sidebars.js
  2. 再把 docs/site-configs/docusaurus-navbar.json 合并进 themeConfig.navbar.items
  3. 最后根据真实站点的 routeBasePathdocs 配置微调路径

如果你后续接 VitePress

  1. 先参考 docs/site-configs/vitepress-theme-config.ts
  2. navsidebar 合并进 themeConfig
  3. 再按实际站点结构调整分组默认展开策略

设计原则

  • 默认优先展示“首页与主线篇”
  • 专题、项目、示例、附录默认折叠,避免首屏过重
  • 示例层同时覆盖文档示例、输出样本、截图清单和可运行骨架
  • 求职闭环相关内容在导航里保持显性,方便作品集与面试准备