Skip to content

feat: Jekyll → VitePress 文档站迁移 - #24

Merged
devcxl merged 1 commit into
mainfrom
feat/vitepress-docs-migration
Jul 9, 2026
Merged

feat: Jekyll → VitePress 文档站迁移#24
devcxl merged 1 commit into
mainfrom
feat/vitepress-docs-migration

Conversation

@devcxl

@devcxl devcxl commented Jul 9, 2026

Copy link
Copy Markdown
Owner

概述

将文档站从 Jekyll 迁移到 VitePress,与项目 TypeScript/Vite 技术栈统一。

变更内容

  • 依赖: 安装 vitepress,新增 docs:dev/docs:build/docs:preview scripts
  • 配置: docs/.vitepress/config.ts — 自动侧边栏、导航栏、minisearch 搜索、社交链接
  • 首页: VitePress home layout(hero + features)+ npm/CI badge + 命令一览
  • CI/CD: pages.yml 从 Jekyll 改为 VitePress 构建(npm ci → npm run docs:build → upload-pages-artifact
  • 清理: 删除 docs/_config.yml(Jekyll 配置)
  • 链接修复: 所有内部链接改为 clean URL 格式

验证

  • npm run docs:build 成功,29 个页面全部构建(3.78s)
  • 本地 npm run docs:dev 可正常预览

关联 Issue

Closes #17

- 安装 vitepress,添加 docs:dev/docs:build/docs:preview scripts
- 创建 docs/.vitepress/config.ts(自动侧边栏、导航栏、搜索、社交链接)
- 首页改为 VitePress home layout + npm badge + 命令一览
- 修复内部链接格式为 clean URL
- 更新 pages.yml 为 VitePress 构建流程
- 删除 Jekyll 配置 docs/_config.yml
- 更新 .gitignore 添加 .vitepress-dist
@devcxl
devcxl merged commit 1f9e68a into main Jul 9, 2026
1 check passed
@devcxl
devcxl deleted the feat/vitepress-docs-migration branch July 9, 2026 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

VitePress 文档站迁移

1 participant