add index in docs

ValKmjolnir · ValKmjolnir · commit 4251a1a45c46 · 2023-12-19T10:58:43.000+08:00
diff --git a/doc/1_abstract.md b/doc/1_abstract.md
@@ -1,3 +1,9 @@
+---
+title: "摘要"
+layout: about
+nav_order: 2
+---
+
 随着大规模软件开发的普及，对可扩展且易于适应的静态代码分析技术的需求正在加大。传统的静态分析工具，如 Clang Static Analyzer (CSA) 或 PMD，在检查编程规则或样式问题方面已经展现出了良好的效果。然而，这些工具通常是为了满足特定的目标而设计的，往往无法满足现代软件开发环境中多变和多元化的需求。这些需求可以涉及服务质量 (QoS)、各种编程语言、不同的算法需求，以及各种性能需求。例如，安全团队可能需要复杂的算法，如上下文敏感的污点分析，来审查较小的代码库，而项目经理可能需要一种相对较轻的算法，例如计算圈复杂度的算法，以在较大的代码库上测量开发人员的生产力。
 这些多元化的需求，加上大型组织中常见的计算资源限制，构成了一项重大的挑战。由于传统工具采用的是问题特定的计算方式，往往无法在这种环境中实现扩展。因此，我们推出了 CodeQuery，这是一个专为大规模静态分析设计的集中式数据平台。
 在 CodeQuery 的实现中，我们把源代码和分析结果看作数据，把执行过程看作大数据处理，这与传统的以工具为中心的方法有着显著的不同。我们利用大型组织中的常见系统，如数据仓库、MaxCompute 和 Hive 等数据计算设施、OSS 对象存储和 Kubernetes 等灵活计算资源，让 CodeQuery 能够无缝地融入这些系统中。这种方法使 CodeQuery 高度可维护和可扩展，能够支持多元化的需求，并有效应对不断变化的需求。此外，CodeQuery 的开放架构鼓励各种内部系统之间的互操作性，实现了无缝的交互和数据交换。这种集成和交互能力不仅提高了组织内部的自动化程度，也提高了效率，降低了手动错误的可能性。通过打破信息孤岛，推动更互联、更自动化的环境，CodeQuery 显著提高了软件开发过程的整体生产力和效率。
diff --git a/doc/2_introduction.md b/doc/2_introduction.md
@@ -1,3 +1,9 @@
+---
+title: "简介"
+layout: default
+nav_order: 3
+---
+
 CodeFuse-Query 是一个支持对 **各种编程语言** 进行 **结构化分析** 的 **代码数据平台**。核心思想是利用各种语言解析器将所有代码转化为数据，并将其结构化存储到代码数据库中。通过使用自定义查询语言，按照业务需求进行数据分析。如下图所示：
 ![image.png](../assets/introduction01.png)
 
diff --git a/doc/3_install_and_run.md b/doc/3_install_and_run.md
@@ -1,3 +1,9 @@
+---
+title: "安装、配置、运行"
+layout: page
+nav_order: 4
+---
+
 # 安装、配置、运行
 
 ## 硬件和软件要求 
diff --git a/doc/4_godelscript_language.md b/doc/4_godelscript_language.md
@@ -1,3 +1,9 @@
+---
+title: "GödelScript 查询语言"
+layout: default
+nav_order: 5
+---
+
 # GödelScript 查询语言
 
 ## GödelScript 基本概念和语法
diff --git a/doc/5_toolchain.md b/doc/5_toolchain.md
@@ -1,3 +1,9 @@
+---
+title: "开发插件 (VSCode)"
+layout: default
+nav_order: 6
+---
+
 # 开发插件(VSCode)
 ## 安装
 
diff --git a/doc/Gemfile.lock b/doc/Gemfile.lock
@@ -74,6 +74,7 @@ GEM
     webrick (1.8.1)
 
 PLATFORMS
+  arm64-darwin-21
   arm64-darwin-23
   x86_64-linux
 
diff --git a/doc/index.md b/doc/index.md
@@ -1,10 +1,11 @@
 ---
 title: Home
-layout: home
+layout: default
+nav_order: 1
 ---
 ## 文档 (Documentation)
-- [引言](1_abstract.md)
-- [概述](2_introduction.md)
-- [安装、配置、运行](3_install_and_run.md)
-- [Godel查询语言介绍](4_godelscript_language.md)
-- [VSCode开发插件](5_toolchain.md)
+- [引言](1_abstract.html)
+- [概述](2_introduction.html)
+- [安装、配置、运行](3_install_and_run.html)
+- [GödelScript 查询语言介绍](4_godelscript_language.html)
+- [VSCode开发插件](5_toolchain.html)
