跳转至

添加新页面

如果您认为有必要,可以在文档的任何位置添加新页面。但是,我们建议在添加新页面之前与文档开发人员确认,以确保该页面是必需的。

创建页面

首先,您需要创建一个新文件,文件名全部使用小写,可以使用连字符(-)代替空格。例如,这个文件名为 adding-pages.md。该文件应位于您希望它所在的区域,例如;如果您想在文档的“贡献”部分添加一个新页面,您需要在 docs/contributing/hass-agent-documentation/ 目录下创建该页面。

现在,您可以使用一级标题来表示页面的名称。例如:# 添加新页面

添加到导航树

接下来,您需要打开文档根目录下的 mkdocs.yml 文件。在文件的最底部,您会看到:

nav:
  - Home: index.md

要添加您的页面,您需要找到您放置文件的位置,例如,位于 docs/contributing/hass-agent-documentation 目录下的文件应该添加在以下位置:

nav:
  - Helping Out:
      - Developing the Documentation:

您通过缩进并添加 - 来创建一个新条目,然后写入您希望在侧边栏导航中显示的页面的名称,保持其简短。然后,您添加一个 : 并跟随着文件的目录。

Note

此目录从 docs 文件夹开始,因此您只需要写入 contributing/hass-agent-documentation,而不是 docs/contributing/hass-agent-documentation

编辑和测试页面

现在您可以编辑页面并填充内容,所有的更改都应在您的浏览器中显示,并且页面应在左侧导航栏中可见。