3.3. 使用 TechDocs 附加组件
在管理员在 Red Hat Developer Hub 实例中安装 TechDocs 附加组件后,您可以使用它来扩展 TechDocs 插件的功能,并增强您的文档体验。
3.3.1. 使用 ReportIssue TechDocs 附加组件 复制链接链接已复制到粘贴板!
如果您在机构的 TechDocs 文档中发现错误,您可以使用 ReportIssue 附加组件直接打开新的 GitHub 或 GitLab 问题。Report Isue 自动导入您在仓库中突出显示的文档中的文本。
先决条件
-
在 TechDocs 插件中安装并启用
ReportIssue附加组件。 - 您有在报告文档问题的存储库中创建问题的权限。
步骤
- 在您的 TechDocs 文档中,突出显示您要报告问题的文本。
-
单击
ReportIssue框中的文本,如 Open new GitHub issue。 在存储库中的新问题页面中,使用模板来创建您要报告的问题。
注意默认问题标题为 Documentation feedback: < ;highlighted_text& gt;,其中 < ;highlighted_text > 是您在 TechDocs 文档中突出显示的文本。
在问题描述中,<highlighted_text > 是 The highlighted text 字段的默认值。
验证
- 您创建的问题会在仓库中的 issues 页面中列出。
3.3.2. 使用 TextSize TechDocs 附加组件 复制链接链接已复制到粘贴板!
您可以使用 TextSize 附加组件来更改 TechDocs Reader 页面或 Entity 页面中的文本大小。
先决条件
-
TextSize附加组件已在 TechDocs 插件中安装并启用。
步骤
- 在 TechDocs 标头中,点 Settings 图标。
使用滑块调整文档文本的大小。
注意- 默认文本大小为 100%
- 最小化文本大小为 90%
- 最大文本大小为 150%
3.3.3. 使用 LightBox TechDocs 附加组件 复制链接链接已复制到粘贴板!
如果您的 TechDocs 文档包含一个镜像,您可以使用 LightBox 附加组件在 lightbox 或 overlay 窗口中查看镜像的放大版本。您还可以缩放来更改 lightbox 镜像的大小。如果单个文档页面包含多个镜像,您可以在 lightbox 中的镜像之间进行导航。
先决条件
-
LightBox附加组件已在 TechDocs 插件中安装并启用。
步骤
- 在您的 TechDocs 文档中,点您要在 lightbox 中查看的镜像。
在 lightbox 中,您可以执行以下操作:
- 点镜像或滚动以缩放或缩放。
- 点箭头在镜像间导航。