跳转至

共享内容测试平台

本节内容旨在验证从本仓库提供的共享内容,以便在BeeWare文档的其余部分中使用。"共享内容"指的是多个仓库共用的文档或文档部分。这些内容存储于此处以便在各仓库中包含。这意味着当需要更新时,仅需修改单一来源,该变更将自动同步至所有使用该共享内容的仓库。

若您正在更新现有内容,则无需执行以下步骤。您只需构建测试站点,即可查看更新后的内容呈现效果。

若您正在shared-content目录下创建新的共享文档文件,且该文件不应包含在how-to目录中,请完成以下操作:

  1. content_test_bed中创建一个文件,其文件名与您的新内容文件相同,并在末尾附加"_include"。
    • 对于 style_guide.md, 你需要添加 style_guide_include.md.
  2. 使用片段语法时,请将文件名添加到filename_include.md中。包含内容的片段语法为-8<- "filename.md"
    • 对于 style_guide.md,你需要在 -8<- "style_guide.md" 中添加 style_guide_include.md
  3. 更新Shared content test bed部分中的/docs/SUMMARY.md内容,包含新的_include文件及其路径,并保持与该部分其他项目相同的缩进级别。
    • 对于 style_guide_include.md,你需要添加 - [Style guide](content_test_bed/style_guide_include.md)

完成这些步骤后,您即可构建测试站点并查看新文档的渲染效果。