文档工具演示¶
主题检查清单¶
本演示旨在测试BeeWare MkDocs Material主题覆盖功能的各项特性。请仔细阅读并确认本页及后续页面所列内容均存在且功能如描述所述正常运作。
标题栏¶
页面上显示着中等灰色的标题栏。这表明主题模板已应用。
页眉图标¶
左上角的页眉图标已渲染完成。这证实了模板能够引用外部资源。
主页侧边栏图标¶
左侧边栏中的徽标图标已渲染完成。该徽标的宽度应与边栏宽度一致,高度也应与边栏等高。网站标题应以略大于边栏其他内容的字体显示在徽标下方,其下方则以较小字体标注版本号。
这证实了侧边栏将在目标网站上正确显示。
标题字体¶
标题采用斜体显示。这表明BeeWare自定义CSS主题已成功应用。
内联代码¶
内联代码以与周围字体相同的颜色呈现。这证实了主题并未引发任何意外变化。
这是一段包含 inline code 和 inline code 的文本。
标签式内容代码¶
代码采用与背景色相异的颜色。复制按钮应仅复制命令行,不包含提示符。
这确认了主题未引发任何意外变更,同时验证了复制按钮是否按预期正常工作。
$ git clone https://github.com/beeware/beeware-theme.git
$ git clone https://github.com/beeware/beeware-theme.git
C:\...>git clone https://github.com/beeware/beeware-theme.git
代码复制按钮行为¶
以下代码块中的复制按钮应将 from pathlib import Path 复制到剪贴板。
from pathlib import Path
以下代码块中的复制按钮应将 ls beeware-docs-tools 复制到剪贴板。不应包含 shell 提示符和输出内容。
(venv) $ ls beeware-docs-tools
_build locales requirements.dev.txt tox.ini
docs pyproject.toml requirements.docs.txt
LICENSE README.md src
侧边栏链接¶
侧边栏链接存在,且指向beeware-docs-tools仓库。这证实了侧边栏内容已加载,且project-name已在MkDocs配置文件中设置,同时版本号已计算并添加。
链接颜色¶
此处指向BeeWare主网站的链接在浅色模式和深色模式下都应显示为蓝色。
左右侧边栏中的链接在两种模式下也应显示为蓝色。
在向下滚动页面时,右侧边栏中的活动标题链接在深色模式下应为浅蓝色,在浅色模式下则应为深蓝色。
译文告诫¶
本文件的英文版本应显示下方的"提供翻译版本"提示。法语翻译版本应显示"此为机器翻译!"提示。德语翻译版本应显示"此为人工翻译!"提示。
这是机器翻译!
本教程版本由机器翻译生成。我们深知这并非理想选择,但认为劣质翻译总比没有翻译要好。
自定义404页面¶
在浏览器中将 URL 末尾添加 nopage 以验证 404 页面是否存在,并包含文本 "Brutus 找不到您要查找的内容"。由于 MkDocs
的问题,当前 404 页面有时无法正确显示图片。
MkDocs 构建会因未识别的内部链接而失败,因此您需要通过在浏览器中修改 URL 手动验证此检查。
下次检查¶
以下链接将引导您访问BeeWare文档工具演示区块一。此链接用于验证跨页面链接功能。
请导航至BeeWare 文档工具演示部分一进行后续检查。