第 1 章 关于 TechDocs
Red Hat Developer Hub 实例会预安装并启用 TechDocs 插件。您的组织可以使用 TechDocs 插件在中央位置并以标准化的方式创建、查找和管理文档。您还可以使用内置 TechDocs 功能和附加组件来增强您的技术文档体验。例如:
- 文档类代码方法
- 在 Markdown 文件中编写存储在项目存储库中的技术文档以及您的代码。
- 文档站点生成
- 使用 MkDocs 为您的在 Developer Hub 中呈现的文档创建一个功能全面、基于 Markdown 的静态 HTML 站点。
- 文档站点元数据和集成
- 请参阅有关文档站点的额外元数据以及静态文档,如最后一次更新的日期、站点所有者、顶级贡献者、打开 GitHub 问题、Slack 支持频道和 Stack Overflow Enterprise 标签。
- 内置导航和搜索
- 在文档内快速轻松地找到您所需的信息。
- 附加组件
- 将您的文档的功能更强,与支持的 TechDocs 附加组件交互。默认情况下,预装并启用一些附加组件。要扩展默认功能,您可以在 Red Hat Developer Hub 实例中动态加载外部和第三方附加组件。如果要进一步自定义 TechDocs 体验,您可以创建满足您的机构特定文档需求的附加组件。