use mkdocs

.github/workflows/gh-pages.yml

@@ -6,8 +6,8 @@ name: Deploy mdBook site to Pages
 
 on:
   # Runs on pushes targeting the default branch
-  push:
-    branches: ["main"]
+  #push:
+  #  branches: ["main"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -32,30 +32,25 @@ jobs:
       MDBOOK_VERSION: 0.4.21
     steps:
       - uses: actions/checkout@v3
-      - name: Install mdBook
+      - name: Install Dependencies
         run: |
-          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
-          rustup update
-          cargo install --version ${MDBOOK_VERSION} mdbook
+          python3 -m pip install -r ./docs/requirements.txt
 
       - name: Setup Pages
-        id: pages
-        uses: actions/configure-pages@v3
-
-      - name: Build with mdBook
-        run: mdbook build
+        run: |
+          mkdocs build
         working-directory: ./docs
 
       - name: Doxygen Action
         uses: mattnotmitt/doxygen-action@v1.9.5
         with:
           working-directory: .
-          doxyfile-path: ./Doxyfile
+          doxyfile-path: ./docs/Doxyfile
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
-          path: docs/book
+          path: docs/site
 
   # Deployment job
   deploy:

Doxyfile → docs/Doxyfile

@@ -68,7 +68,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = docs/book/design/doxy
+OUTPUT_DIRECTORY       = docs/site/design/doxy
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
 # sub-directories (in 2 levels) under the output directory of each output format

docs/src/blog/1.md → docs/docs/blog/1.md

@@ -1,3 +1,7 @@
+---
+title: High-Performance Concurrency Control Mechanisms for Main-Memory Databases
+---
+
 > 本篇文章来自 [OceanBase](https://github.com/oceanbase/oceanbase) 内部论文分享
 
 本篇文章分享的论文是[《High-Performance Concurrency Control Mechanisms for Main-Memory Databases》](https://www.microsoft.com/en-us/research/wp-content/uploads/2011/12/MVCC-published-revised.pdf),该论文介绍了微软SQL Server内存数据库Hekaton所使用的并发控制算法原型，提出了一种无锁的乐观并发控制以及一种无锁的悲观并发控制方法，最终Hekaton采用的是其中的乐观并发控制方法，其也是第一个在生产中将OCC落地的数据库。欢迎感兴趣的同学一起交流学习~

docs/src/blog/introduction.md → docs/docs/blog/introduction.md

@@ -1 +1,5 @@
+---
+title: 介绍
+---
+
 MiniOB 博客放一些数据库技术实现原理相关的内容，有些来自[OceanBase](https://github.com/oceanbase) 内部分享的一些论文阅读笔记、技术分享、开发心得等，希望能够帮助大家了解数据库。

docs/src/design/miniob-architecture.md → docs/docs/design/miniob-architecture.md

@@ -1,3 +1,7 @@
+---
+title: MiniOB架构
+---
+
 # MiniOB代码架构框架设计和说明
 
 # MiniOB代码结构说明

docs/src/design/miniob-bplus-tree-concurrency.md → docs/docs/design/miniob-bplus-tree-concurrency.md

@@ -1,3 +1,6 @@
+---
+title: B+ 树并发操作
+---
 
 > [MiniOB](https://github.com/oceanbase/miniob) 是 [OceanBase](https://github.com/oceanbase/oceanbase) 联合华中科技大学推出的一款用于教学的小型数据库系统，希望能够帮助数据库爱好者系统性的学习数据库原理与实战。
 # B+ 树介绍

docs/src/design/miniob-bplus-tree.md → docs/docs/design/miniob-bplus-tree.md

@@ -1,3 +1,7 @@
+---
+title: B+Tree 实现
+---
+
 # MiniOB B+Tree 实现
 
 ## 简介

docs/src/design/miniob-buffer-pool.md → docs/docs/design/miniob-buffer-pool.md

@@ -1,3 +1,7 @@
+---
+title: 存储实现
+---
+
 # MiniOB 存储实现
 
 本节将从存储层面介绍 MiniOB 的实现。

docs/src/design/miniob-double-write-buffer.md → docs/docs/design/miniob-double-write-buffer.md

@@ -1,3 +1,7 @@
+---
+title: Double Write Buffer 实现
+---
+
 # MiniOB Double Write Buffer 实现
 
 ## 当前MiniOB的问题

docs/src/design/miniob-durability.md → docs/docs/design/miniob-durability.md

@@ -1,3 +1,7 @@
+---
+title: 持久化
+---
+
 本文介绍 [MiniOB](https://github.com/oceanbase/miniob) 中的 clog 模块是如何工作的。
 
 # 背景

docs/src/design/miniob-how-to-add-new-sql.md → docs/docs/design/miniob-how-to-add-new-sql.md

@@ -1,3 +1,7 @@
+---
+ttile: 如何新增一种类型的SQL语句
+---
+
 > 本文介绍如何新增一种类型的SQL语句。
 
 当前的SQL实现已经比较复杂，这里以新增一个简单的SQL语句为例，介绍如何新增一种类型的SQL语句。

docs/src/design/miniob-mysql-protocol.md → docs/docs/design/miniob-mysql-protocol.md

@@ -1,3 +1,7 @@
+---
+title: MySQL 协议
+---
+
 > 本篇文档介绍MySQL的通讯流程以及MiniOB对它的支持与实现
 
 # MiniOB 通讯协议简介

docs/src/design/miniob-sql-expression.md → docs/docs/design/miniob-sql-expression.md

@@ -1,3 +1,7 @@
+---
+title: SQL 表达式
+---
+
 > 本文介绍如何解析表达式
 
 # 介绍

docs/src/design/miniob-sql-parser.md → docs/docs/design/miniob-sql-parser.md

@@ -1,3 +1,7 @@
+---
+title: SQL 词法语法分析
+---
+
 > 这部分内容会介绍一些如何对miniob中的词法语法分析模块进行开发与调试，以及依赖的工具。
 
 # 简介

docs/src/design/miniob-thread-model.md → docs/docs/design/miniob-thread-model.md

@@ -1,3 +1,7 @@
+---
+title: 线程模型
+---
+
 > 本篇文档介绍 MiniOB 中的线程池模型。
 
 # 简介

docs/src/design/miniob-transaction.md → docs/docs/design/miniob-transaction.md

@@ -1,3 +1,7 @@
+---
+title: 事务模块
+---
+
 本篇文档介绍 MiniOB 中的事务模块是如何工作的。
 
 # 背景

docs/src/dev-env/dev_by_gitpod.md → docs/docs/dev-env/dev_by_gitpod.md

@@ -1,3 +1,7 @@
+---
+title: 使用 GitPod 开发 MiniOB
+---
+
 > [MiniOB](https://github.com/oceanbase/miniob) 是 [OceanBase](https://github.com/oceanbase/oceanbase) 联合华中科技大学推出的一款用于教学的小型数据库系统，希望能够帮助数据库爱好者系统性的学习数据库原理与实战。
 
 本篇文章介绍如何使用 [GitPod](https://www.gitpod.io/) 开发 [MiniOB](https://github.com/oceanbase/miniob)。

docs/src/dev-env/how-to-dev-using-docker.md → docs/docs/dev-env/how-to-dev-using-docker.md

@@ -1,3 +1,7 @@
+---
+title: 使用Docker开发MiniOB
+---
+
 本篇文章介绍如何使用Docker来开发MiniOB。
 
 MiniOB 依赖的第三方组件比较多，搭建开发环境比较繁琐，建议同学们直接使用我们提供的Docker环境进行开发。

docs/src/dev-env/how_to_dev_in_docker_container_by_vscode.md → docs/docs/dev-env/how_to_dev_in_docker_container_by_vscode.md

@@ -1,3 +1,7 @@
+---
+title: 使用 Docker 和 VSCode 远程开发 Miniob
+---
+
 # 使用 Docker 和 VSCode 远程开发 Miniob
 
 本文档阐述如何使用 Docker 构建一个具备 Miniob 开发环境的容器，并且通过 VSCode 的 Remote-SSH 插件 SSH 到容器中进行远程开发。Docker 和 VSCode 可以安装在不同机器上。

docs/src/dev-env/how_to_dev_in_docker_container_by_vscode_on_windows.md → docs/docs/dev-env/how_to_dev_in_docker_container_by_vscode_on_windows.md

@@ -1,3 +1,7 @@
+---
+title: 在windows上通过docker配置环境并利用vscode调试代码（手把手版）
+---
+
 # 在windows上通过docker配置环境并利用vscode调试代码（手把手版）
 
 -- 由严奕凡编写，就读于重庆大学.

docs/src/dev-env/how_to_dev_miniob_by_docker_on_windows.md → docs/docs/dev-env/how_to_dev_miniob_by_docker_on_windows.md

@@ -1,3 +1,7 @@
+---
+title: Windows 如何使用 Docker 开发miniob
+---
+
 Windows 如何使用 Docker 开发miniob
 
 miniob 是 OceanBase联合华中科技大学开发的一款帮助零基础开发者数据库开发实战的系统，目前已经开源，可以在GitHub网站查看：[miniob github首页](https://github.com/oceanbase/miniob)。

docs/src/dev-env/how_to_dev_miniob_by_vscode.md → docs/docs/dev-env/how_to_dev_miniob_by_vscode.md

@@ -1,3 +1,7 @@
+---
+title: 使用vscode开发miniob
+---
+
 # 环境准备
 ## 运行环境
 * 操作系统

docs/src/dev-env/introduction.md → docs/docs/dev-env/introduction.md

@@ -1,3 +1,7 @@
+---
+title: 开发环境介绍
+---
+
 # 搭建开发环境
 
 MiniOB 当前可以在Linux/MacOS上编译，所以开发环境最好是Linux或者MacOS。Windows上可以使用WSL2，或者使用Docker。这里有几个文档，大家可以参考并选择自己的开发环境。另外，很多同学喜欢使用visual studio code开发，MiniOB 中也将vscode的一些配置文件放在了仓库中，比如 .vscode/tasks.json 和 .vscode/launch.json，可以参考使用。

docs/src/dev-env/miniob-how-to-debug.md → docs/docs/dev-env/miniob-how-to-debug.md

@@ -1,6 +1,9 @@
-# miniob调试篇
+---
+title: 调试
+author: caizj
+---
 
--- by caizj
+# miniob调试篇
 
 调试c/c++程序，常用的有两种方式，一是打印日志调试，二是gdb调试，调试不仅可以定位问题，也可以用来熟悉代码。
 

docs/src/game/debug-output.md → docs/docs/game/debug-output.md

@@ -1,3 +1,7 @@
+---
+title: 输出调试信息
+---
+
 本篇文档介绍如何向[训练营](https://open.oceanbase.com/train)输出调试信息。
 
 在使用训练营提交测试时，有时候会遇到本地环境没有问题，但是训练营上的输出总是不符合预期。但是训练营没有办法调试，这时候就需要在训练营上输出调试信息，以便于定位问题。

docs/src/game/gitee-instructions.md → docs/docs/game/gitee-instructions.md

@@ -1,3 +1,7 @@
+---
+title: MiniOB Gitee 在训练营中的使用说明
+---
+
 # MiniOB Gitee 在训练营中的使用说明
 
 实战 MiniOB 编程需要在 Gitee 上创建自己的 private 仓库，在开发完成后，将代码提交到自己的仓库中，然后在训练营中进行测试。

docs/src/game/github-introduction.md → docs/docs/game/github-introduction.md

@@ -1,3 +1,7 @@
+---
+title: MiniOB GitHub 在训练营中的使用说明
+---
+
 # MiniOB GitHub 在训练营中的使用说明
 
 训练营测试后端现在支持使用 [GitHub](https://github.com) 和 [Gitee](https://gitee.com) 作为代码仓库管理平台。

docs/src/game/introduction.md → docs/docs/game/introduction.md

@@ -1,3 +1,7 @@
+---
+title: OceanBase 数据库大赛
+---
+
 > ***注意*** 由于最新代码的事务模型与2022年已经不同，因此最新代码不能通过MiniOB-2022的训练营测试的basic用例，但是不影响做其它的用例测试。同学们遇到官方代码无法通过MiniOB-2022的basic用例，请忽略。
 
 # OceanBase 数据库大赛

docs/src/game/miniob-date-implementation.md → docs/docs/game/miniob-date-implementation.md

@@ -1,3 +1,7 @@
+---
+title: Date 实现解析
+---
+
 # Date实现解析
 
 > 此实现解析有往届选手提供。具体代码实现已经有所变更，因此仅供参考。

docs/src/game/miniob-drop-table-implementation.md → docs/docs/game/miniob-drop-table-implementation.md

@@ -1,3 +1,7 @@
+---
+title: Drop table 实现解析
+---
+
 # miniob - drop table 实现解析
 
 > 此实现解析有往届选手提供。具体代码实现已经有所变更，因此仅供参考。

docs/src/game/miniob-output-convention.md → docs/docs/game/miniob-output-convention.md

@@ -1,3 +1,6 @@
+---
+title: 输出规范
+---
 
 对于比赛和训练营测试后台，需要做一些输出约定，才能正确的进行测试。
 

docs/src/game/miniob-test-comment-date.md → docs/docs/game/miniob-test-comment-date.md

@@ -1,3 +1,6 @@
+---
+title: Date 测试解说
+---
 
 > 此实现解析有往届选手提供。具体代码实现已经有所变更，因此仅供参考。
 

docs/src/game/miniob_topics.md → docs/docs/game/miniob_topics.md

@@ -1,3 +1,7 @@
+---
+title: OceanBase 数据库大赛2021届题目
+---
+
 miniob 题目
 
 # 背景

docs/src/how_to_build.md → docs/docs/how_to_build.md

@@ -1,3 +1,7 @@
+---
+title: 如何编译
+---
+
 # 如何编译
 
 ## 0. base

docs/src/how_to_run.md → docs/docs/how_to_run.md

@@ -1,3 +1,7 @@
+---
+title: 如何运行
+---
+
 # 如何运行
 
 编译完成后，可以在build目录（可能是build_debug或build_release）下找到bin/observer，就是我们的服务端程序，bin/obclient是自带的客户端程序。

docs/src/lectures/copyright.md → docs/docs/lectures/copyright.md

@@ -1,3 +1,7 @@
+---
+title: 版权声明
+---
+
 # 版权声明
 
 本版权声明仅针对《数据库管理系统实现基础讲义》（以下简称“本教材”）的所有内容。

docs/src/lectures/lecture-1.md → docs/docs/lectures/lecture-1.md

@@ -1,3 +1,7 @@
+---
+title: 第1章 数据库管理系统概述
+---
+
 # 第1章 数据库管理系统概述
 
 ## 1.1 课程简介

docs/src/lectures/lecture-2.md → docs/docs/lectures/lecture-2.md

@@ -1,3 +1,6 @@
+---
+title: 第2章 数据库的存储结构
+---
 
 # 第2章 数据库的存储结构
 

docs/src/lectures/lecture-3.md → docs/docs/lectures/lecture-3.md

@@ -1,3 +1,6 @@
+---
+title: 第3章 索引结构
+---
 
 # 第3章 索引结构
 

docs/src/lectures/lecture-4.md → docs/docs/lectures/lecture-4.md

@@ -1,3 +1,6 @@
+---
+title: 第4章 查询处理
+---
 
 # 第4章 查询处理
 

docs/src/lectures/lecture-5.md → docs/docs/lectures/lecture-5.md

@@ -1,3 +1,6 @@
+---
+title: 第5章 查询优化
+---
 
 # 第5章 查询优化
 

docs/src/lectures/lecture-6.md → docs/docs/lectures/lecture-6.md

@@ -1,3 +1,6 @@
+---
+title: 第6章 事务处理
+---
 
 # 第6章 事务处理
 

docs/src/lectures/references.md → docs/docs/lectures/references.md

@@ -1,3 +1,7 @@
+---
+title: 参考资料
+---
+
 # 参考资料
 
 1. 王珊, 萨师煊. 数据库系统概论(第5版). 北京: 高等教育出版社, 2014

docs/src/miniob-introduction.md → docs/docs/miniob-introduction.md

@@ -1,3 +1,7 @@
+---
+title: MiniOB 介绍
+---
+
 # MiniOB 介绍
 
 MiniOB 是 [OceanBase](https://github.com/oceanbase/oceanbase) 团队基于华中科技大学数据库课程原型，联合多所高校重新开发的、专为零基础的同学设计的数据库入门学习项目。我们的目标是为在校学生、数据库从业者、爱好者或对基础技术感兴趣的人提供一个友好的数据库学习项目。