本文首先发表在星云格拉夫社区公共帐户中
世界上没有完美的产品，每个不完美的产品都需要文档。
创建产品后，我们需要一个文档来回答以下问题：
通过该文档介绍此信息，新读者可以更直观地理解产品并决定是否使用它，并且产品的用户可以更顺畅地使用它。
Nebul图也是一个不完美的产品。因此，我们需要文档，并且需要以有序的安排来存储和安排文档中心，以便读者阅读和查找。
一开始，我们的第一位文档工程师@AMBER只有一个需求，也就是说，要构建一个英语文档网站。但是，她很快发现这不仅仅是需求。
经过初步分析后，我们至少需要做以下事情：
随着时间的流逝和进一步的思考，鸭子发现了更多的需求：
结果，柯达开始探索文档的中心。
让我们解释一下星云内容和文档团队如何使用MKDOCS和GITHUB来构建文档中心。在阅读本文时，您可以从Nebula Graph Document中心（链接：https：//docs.nebula-graph.com.cn/3.0）。.1/）和github库（链接：https：//github.com/vesoft-inc/nebula-docs-cn）查看相应的代码和效果示例。
MKDOCS是用于构建项目文档的快速，简单且美丽的开源静态网站生成器。文档源文件是标记格式，并在YAML文件中配置。
MKDOCS支持：
MKDOCS的材料是最受欢迎的MKDOC主题之一，并通过Python，Docker，Git和其他方法支持安装。Nebul图文档中心具有该主题的多个功能。
请参阅材料的官方文档MKDOC材料。
注意：无需单独安装MKDOC，材料将将其安装在一起。
我们使用github页面和github操作将github文档库部署到文档中心，并在修改文档后自动更新页面。
GitHub页面使用的域名是域名，我们使用自定义域名。
需要用于网站的基本信息以设置网站的基本信息的配置如下：
在GitHub上设置GitHub信息Nebula文档Lubtosus，因此您需要在中间设置与GitHub相关的信息。
可以通过文件中的字段配置导航栏中的导航栏标记文件的显示顺序。格式示例如下：
显示效果如下：
富含功能中心的文档中心仅具有类似于下图的默认页面样式。我们需要选择配置项和插件以实现更多功能。
将以下配置应用于文件：
并使用mkdocs-material添加一行。这样，应用材料主题的基本样式：
设置MKDOCS的站点语言材料支持多种语言。例如，如果是中文文档，请进行以下设置：
使用两种类型的颜色主题，浅色背景默认值和深色背景板块更改页面颜色材料，加入调色板字段：
开关页面主题我们可以在深色和光色的主题之间切换以实现白天模式和夜间模式的效果。
此外，您可以自定义颜色。
自定义徽标可以在文档库中使用各种类型的图片，包括但不限于PNG，SVG格式或外部网络上的图片作为页面徽标。Edit文件：
如果是外部链接，请直接设置链接。
关于MKDOC的搜索材料的搜索功能，可以使用编辑文件：
但是，搜索功能在中文和英语混合场景的支持下存在许多问题，我们仍在寻找解决方案。
设置社交主页链接星云图是GitHub的开源产品。因此，设置了GitHub主页的徽标和链接。该方法如下：
设置标题行自动隐藏，以防止标题行覆盖内容并优化阅读体验。我们在页面幻灯片后自动隐藏标题行。
版本分离是星云文档中心的关键功能之一。开源开发星云图迭代速度很快，每个版本的特征都不同。因此，根据产品功能，文档也分为不同的版本。
我们将Mike用于版本管理。
Mike的使用如下：
Nebula Graph文档版本的版本与内核版本一致。发布新版本的文档的方法如下：
版本号码中的版本号自动更改文档有时需要根据版本进行修改。使用宏插件设置宏变量后，只要修改了mkdocs.yl文件中的设置，就可以轻松更改文档中的版本编号。宏的设置步骤如下：
2.在字段中的字段编号中设置宏钥匙值对。示例如下：
设置后，您可以在Markdown代码中以{{。}}的形式生成相应的版本编号。执行上述设置后，{Nebula.Release}}表示2.6.1。
源代码和显示效果的比较如下：
这实际上是短语级别的复制。
以上是为星云的内容和文档团队构建文档。
当然，我们有一些本文中未显示的内容。以下内容将在以后的文章中讲述：
Exchange图数据库技术？加入星云通信组，请先填写您的星云名片，Nebula Assistant会将您吸引到该小组~~
原始：https：//juejin.cn/post/7098525802538467342