构建迁移：GitBook 改为 VitePress

Author: Prodesire

.github/workflows/pages.yml

@@ -1,4 +1,4 @@
-name: Deploy GitBook to GitHub Pages
+name: Deploy VitePress to GitHub Pages
 
 on:
   push:
@@ -35,7 +35,7 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Build GitBook
+      - name: Build with VitePress
         run: npm run build
 
       - name: Configure GitHub Pages
@@ -44,7 +44,7 @@ jobs:
       - name: Upload GitHub Pages artifact
         uses: actions/upload-pages-artifact@v4
         with:
-          path: _book
+          path: .vitepress/dist
 
   deploy:
     runs-on: ubuntu-latest

.gitignore

@@ -10,6 +10,10 @@ node_modules
 # Book build output
 _book
 
+# VitePress build output / cache
+.vitepress/dist
+.vitepress/cache
+
 # eBook build output
 *.epub
 *.mobi

.vitepress/config.mts

@@ -0,0 +1,101 @@
+import { defineConfig } from 'vitepress'
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  lang: 'zh-Hans',
+  title: 'Python 3 源码分析',
+  description: '致力于分析 Python 3.7.0 的源码实现',
+
+  // 部署在 https://flaggo.github.io/python3-source-code-analysis/
+  base: '/python3-source-code-analysis/',
+
+  // 用仓库根目录作为内容源；README.md 作为首页
+  srcDir: '.',
+  rewrites: {
+    'README.md': 'index.md'
+  },
+  // 不作为页面渲染的文件 / 旧构建产物
+  srcExclude: ['SUMMARY.md', '_book/**', '**/node_modules/**'],
+
+  lastUpdated: true,
+  cleanUrls: true,
+  ignoreDeadLinks: true,
+
+  markdown: {
+    lineNumbers: true
+  },
+
+  themeConfig: {
+    // https://vitepress.dev/reference/default-theme-config
+    nav: [
+      { text: '首页', link: '/' },
+      { text: '大纲', link: '/objects/object/' }
+    ],
+
+    sidebar: [
+      {
+        text: '第 1 部分：序章',
+        items: [
+          { text: '前言', link: '/' },
+          { text: 'Python 源代码的组织', link: '/preface/code-organization/' },
+          { text: 'Windows 环境下编译 Python', link: '/preface/windows-build/' },
+          { text: 'UNIX/Linux 环境下编译 Python', link: '/preface/unix-linux-build/' },
+          { text: '修改 Python 源码', link: '/preface/modify-code/' }
+        ]
+      },
+      {
+        text: '第 2 部分：Python 内建对象',
+        items: [
+          { text: 'Python 对象初探', link: '/objects/object/' },
+          { text: 'Python 整数对象', link: '/objects/long-object/' },
+          { text: 'Python 字符串对象', link: '/objects/str-object/' },
+          { text: 'Python List 对象', link: '/objects/list-object/' },
+          { text: 'Python Dict 对象', link: '/objects/dict-object/' },
+          { text: 'Python Set 对象', link: '/objects/set-object/' },
+          { text: '实现简版 Python', link: '/objects/simple-interpreter/' }
+        ]
+      },
+      {
+        text: '第 3 部分：Python 虚拟机',
+        items: [
+          { text: '（编写中…）', link: '/' }
+        ]
+      }
+    ],
+
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/flaggo/python3-source-code-analysis' }
+    ],
+
+    search: {
+      provider: 'local'
+    },
+
+    editLink: {
+      pattern: 'https://github.com/flaggo/python3-source-code-analysis/edit/master/:path',
+      text: '编辑此页面'
+    },
+
+    outline: {
+      label: '本页目录',
+      level: [2, 3]
+    },
+
+    docFooter: {
+      prev: '上一篇',
+      next: '下一篇'
+    },
+
+    lastUpdated: {
+      text: '最后更新于'
+    },
+
+    footer: {
+      copyright: 'Copyright © FlagGo 2019-2026'
+    },
+
+    darkModeSwitchLabel: '主题',
+    returnToTopLabel: '回到顶部',
+    sidebarMenuLabel: '菜单'
+  }
+})

Makefile

@@ -6,8 +6,8 @@ NPM ?= npm
 
 help:
 	@printf "\033[32m%-10s\033[0m %s\n" "install" "安装项目依赖"
-	@printf "\033[32m%-10s\033[0m %s\n" "serve" "运行 GitBook 服务器"
-	@printf "\033[32m%-10s\033[0m %s\n" "build" "构建 GitBook 静态页面"
+	@printf "\033[32m%-10s\033[0m %s\n" "serve" "启动本地预览服务器"
+	@printf "\033[32m%-10s\033[0m %s\n" "build" "构建静态页面"
 	@printf "\033[32m%-10s\033[0m %s\n" "clean" "删除构建产物"
 
 install:
@@ -20,4 +20,4 @@ build:
 	$(NPM) run build
 
 clean:
-	rm -rf _book
+	rm -rf _book .vitepress/dist .vitepress/cache

README.md

@@ -8,58 +8,42 @@
 
 您可以直接访问 [在线版](https://flaggo.github.io/python3-source-code-analysis/)，或者根据以下步骤访问本地版。
 
-## 前置条件
-
-您的系统上需要安装好 node （会自带npm）。
+本项目使用 [VitePress](https://vitepress.dev/) 构建。
 
-## 使用 make 或者使用 npm 命令去构建
+## 前置条件
 
-### 使用 make 命令的方式构建：
+您的系统上需要安装好 Node.js 18 及以上版本（会自带 npm）。
 
-若您可使用 make 命令，简单执行如下命令安装依赖：
+## 安装依赖
 
 ```console
-make install
+npm install
 ```
 
-执行如下命令运行服务端：
+## 本地预览
 
-```console
-make serve
-```
-
-执行如下命令构建静态页面：
+启动本地开发服务器（支持热更新）：
 
 ```console
-make build
+npm run dev
 ```
 
-### 使用 npm 命令的方式构建：
-
-若您不能使用 make 命令，或想直接使用 npm 命令，执行如下命令安装依赖：
+然后访问 http://localhost:5173/python3-source-code-analysis/ 即可查看本书内容。
 
-安装项目依赖：
+> 也可以使用 `make serve`，等价于 `npm run dev`。
 
-```console
-npm install
-```
-
-执行如下命令运行服务端：
+## 构建静态页面
 
 ```console
-npm run serve
+npm run build
 ```
 
-执行如下命令构建静态页面：
+构建产物输出到 `.vitepress/dist`，可用如下命令在本地预览构建结果：
 
 ```console
-npm run build
+npm run preview
 ```
 
-## 访问
-
-直接访问 http://localhost:4000 即可查看本书内容。
-
 # Roadmap
 
 大体按照《Python 源码剖析》中的目录结构进行编写。依次介绍 Python 源码基本信息、内建对象和虚拟机。