文件命名和结构

文件命名规范

为了在文件名中指示文件的层级类型

  • 遵循基于页面和主题的文件命名方法,不要应用任何特殊前缀。

  • 使用连字符作为空格分隔符,以进行搜索引擎优化

例如,technical-considerations-multi-site.rst

目录结构

为了更好地组织,使用子目录按特定分组(例如项目或主题)组织文件。

常见做法包括

  • Figure 子目录包含图像(PNG 和 SVG 源文件)。

  • Sample 子目录包含源代码和配置文件示例。

  • Chapter 子目录存储包含在一个章节中的所有部分,父文件位于顶层目录中。