coref library reference main document will be generated by script

Author: ValKmjolnir

doc/1_abstract.md

@@ -1,9 +1,3 @@
----
-title: "摘要"
-layout: about
-nav_order: 2
----
-
 随着大规模软件开发的普及，对可扩展且易于适应的静态代码分析技术的需求正在加大。传统的静态分析工具，如 Clang Static Analyzer (CSA) 或 PMD，在检查编程规则或样式问题方面已经展现出了良好的效果。然而，这些工具通常是为了满足特定的目标而设计的，往往无法满足现代软件开发环境中多变和多元化的需求。这些需求可以涉及服务质量 (QoS)、各种编程语言、不同的算法需求，以及各种性能需求。例如，安全团队可能需要复杂的算法，如上下文敏感的污点分析，来审查较小的代码库，而项目经理可能需要一种相对较轻的算法，例如计算圈复杂度的算法，以在较大的代码库上测量开发人员的生产力。
 
 这些多元化的需求，加上大型组织中常见的计算资源限制，构成了一项重大的挑战。由于传统工具采用的是问题特定的计算方式，往往无法在这种环境中实现扩展。因此，我们推出了 CodeQuery，这是一个专为大规模静态分析设计的集中式数据平台。

doc/2_introduction.md

@@ -1,9 +1,3 @@
----
-title: "简介"
-layout: default
-nav_order: 3
----
-
 CodeFuse-Query 是一个支持对 **各种编程语言** 进行 **结构化分析** 的 **代码数据平台**。核心思想是利用各种语言解析器将所有代码转化为数据，并将其结构化存储到代码数据库中。通过使用自定义查询语言，按照业务需求进行数据分析。如下图所示：
 ![image.png](../assets/introduction01.png)
 

doc/3_install_and_run.md

@@ -1,9 +1,3 @@
----
-title: "安装、配置、运行"
-layout: page
-nav_order: 4
----
-
 # 安装、配置、运行
 
 ## 硬件和软件要求 

doc/4_godelscript_language.md

@@ -1,9 +1,3 @@
----
-title: "GödelScript 查询语言"
-layout: default
-nav_order: 5
----
-
 # GödelScript 查询语言
 
 ## 目录

doc/5_toolchain.md

@@ -1,9 +1,3 @@
----
-title: "开发插件 (VSCode)"
-layout: default
-nav_order: 6
----
-
 # 开发插件(VSCode)
 ## 安装
 

doc/coref_library_reference.md

@@ -4,9 +4,8 @@ layout: default
 nav_order: 1
 ---
 ## 文档 (Documentation)
-- [引言](1_abstract.html)
-- [概述](2_introduction.html)
-- [安装、配置、运行](3_install_and_run.html)
-- [GödelScript 查询语言介绍](4_godelscript_language.html)
-- [VSCode开发插件](5_toolchain.html)
-- [COREF Library Reference](coref_library_reference.html)
+- [引言](1_abstract.md)
+- [概述](2_introduction.md)
+- [安装、配置、运行](3_install_and_run.md)
+- [GödelScript 查询语言介绍](4_godelscript_language.md)
+- [VSCode开发插件](5_toolchain.md)

doc/index.md

@@ -216,6 +216,22 @@ def dump_schema_tree_view(schema_list) -> str:
         continue
     semantic_dict[file["name"]] = result.stdout.decode("utf-8")
 
+def dump_reference_main_doc():
+    output_file_path = markdown_output_path + "/coref_library_reference.md"
+    output_data = "---\n"
+    output_data += "title: \"COREF Library Reference\"\n"
+    output_data += "layout: default\n"
+    output_data += "nav_order: 2\n"
+    output_data += "has_children: true\n"
+    output_data += "---\n\n"
+    output_data += "# COREF Library Reference\n\n"
+    for file in input_file_list:
+        output_data += "* [coref::" + name_mapper[file["name"]] + "]"
+        output_data += "(./" + name_mapper[file["name"]] + "/reference.html)\n"
+    open(output_file_path, "w").write(output_data)
+
+dump_reference_main_doc()
+
 for file in input_file_list:
     file_full_path = file["path"] + "/" + file["name"]
     print("Generate markdown for " + file_full_path)