Skip to main content

TechDocs 常见问题

本页回答了有关以下方面的常见问题技术文档.

技术​

TechDocs 使用什么静态网站生成器？​

TechDocs 正在使用MkDocs来构建项目文档。技术文档容器正在使用 MkDocs材料主题.

什么是 mkdocs-techdocs-core 插件？​

mkdocs-techdocs-core软件包是一个 MkDocs 插件，它的作用类似于对多个 MkDocs 插件(例如MkDocs Monorepo 插件) 以及 TechDocs 支持的一系列 Python Markdown 扩展。

TechDocs 是否支持 Markdown 以外的文件格式(如 RST、AsciiDoc)？​

现在还不行。 我们目前使用 MkDocs 从源代码生成文档，因此文件必须是 Markdown 格式。 不过，将来我们希望支持其他静态网站生成器，这样就可以使用其他文件格式了。

使用外部构建和存储时，backstage.io/techdocs-ref的值应该是多少？​

的价值backstage.io/techdocs-ref元数据注释用于 TechDocs 的构建过程。技术文档生成器设置为'external'于app-config.yaml但注释仍应存在于实体描述符文件中(例如："......")。catalog-info.yaml)，以便 Backstage 知道该实体已启用 TechDocs。

用户是否可以对 TechDocs 页面提出修改建议或反馈意见？​

源代码托管在 GitHub 或 GitLab 中的 TechDocs 网站支持此功能。 要在 TechDocs 页面上添加 "编辑此页面 "和 "留下反馈 "按钮，请确保您已拥有repo_url和edit_uri您的mkdocs.yml每个MkDocs 说明.

如果源代码托管 URL 的主机名不包括github或gitlab，一个integrations您的app-config.yaml还需要指向源代码提供者的host键是必要的)。