From 7f3db8ad0a3a84a40adb2da5da8b1b99681d34c0 Mon Sep 17 00:00:00 2001 From: luckyasme <807254037@qq.com> Date: Tue, 4 Mar 2025 10:31:45 +0800 Subject: [PATCH] =?UTF-8?q?docs=E4=BC=98=E5=8C=96=E8=B4=A1=E7=8C=AE?= =?UTF-8?q?=E6=8C=87=E5=8D=97=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/zh/Contribute/menu_specifications.md | 28 +++++++++++------------ 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/docs/zh/Contribute/menu_specifications.md b/docs/zh/Contribute/menu_specifications.md index 2d4c84d..21dc206 100644 --- a/docs/zh/Contribute/menu_specifications.md +++ b/docs/zh/Contribute/menu_specifications.md @@ -1,10 +1,10 @@ -# menu文件写作规范 +# menu 文件写作规范 ## 概述 -在文档仓中,针对每个场景及每本手册,均需维护一个`_menu.md`文件。该文件至关重要,其作用在于构建并维护官网所展示的对应目录结构。 +在文档仓中,我们有一个“菜单文件”的概念,其作用在于构建并维护文档对应的目录结构,我们将菜单文件统一命名为`_menu.md`,并在该 markdown 中使用 yaml 元数据来进行配置。针对每个场景及每本手册,我们做了拆分,每本手册维护一个独立的`_menu.md`,这样各手册之间互不干扰,且各个手册均能独立编译。 -## 手册的menu文件 +## 手册的 menu 文件 每本手册都需要维护一个`_menu.md`配置文件来维护该本手册中文档的逻辑关系。 @@ -13,7 +13,6 @@ ```yaml --- label: '内核热升级指南' -ismanual: 'Y' description: '使用用户态自动化工具快速重启内核和程序热迁移实现内核热替换特性' children: - label: '安装与部署' @@ -25,20 +24,19 @@ children: --- ``` -- 顶层 label 指定手册名为“内核热升级指南”。 -- ismanual 设为Y,标识这是一本手册。 -- description 指定该手册的简介说明。 -- children 下配置手册中的文档信息: - - children 下的 label 指定文档的中文名称。 - - children 下的 href 指定文档地址。 +- 顶层 label 指定手册名为“内核热升级指南”。 +- description 指定该手册的简介说明。 +- children 下配置手册中的文档信息: + - children 下的 label 指定文档名称。 + - children 下的 href 指定文档地址(建议使用相对路径)。 呈现效果如下: ![image](figures/内核热升级指南menu.png) -## 场景的menu文件 +## 场景的 menu 文件 -不仅每本手册需维护对应的`_menu.md`文件,各业务场景目录下同样要维护`_menu.md`文件。以服务器场景为例,其`_menu.md`文件示例如下: +不仅每本手册需维护对应的`_menu.md`文件,各业务场景目录下同样要维护`_menu.md`文件。以服务器场景为例,其`_menu.md`文件示例如下: ```yaml --- @@ -117,6 +115,6 @@ children: --- ``` -- 顶层 label 指定场景名,例子中展示的是服务器场景。 -- 服务器 children 下的 label 对应服务器场景下的一级目录,如发行说明、快速入门、安装升级、系统管理等。 -- 每个一级目录 children 下的reference 指向该目录下各本手册的`_menu.md`文件或二级目录。 +- 顶层 label 指定场景名,例子中展示的是服务器场景。 +- 服务器 children 下的 label 对应服务器场景下的一级目录,如发行说明、快速入门、安装升级、系统管理等。 +- 每个一级目录 children 下的 reference 表明引用,您可以使用该字段引用该目录下各本手册的`_menu.md`文件或二级目录,从而形成一个完整的“菜单树”。 \ No newline at end of file -- Gitee