概念
本页介绍 Spotify 在 Backstage 中采用的类文档代码解决方案所引入的概念。
生成技术文档步骤
TechDocs 准备人员
准备是为实体生成文档的第一步，它从源代码托管服务提供商(GitHub、GitLab 等)获取源 markdown 文件，并将文件传送给生成器以进行下一步操作。
有两种准备人员可供选择
通用 Git 编制器 - 在任何版本库 URL 上使用 "git clone"。 URL 阅读器 - 使用源代码托管提供商的 API 下载文件(更快，推荐使用)。
技术文档生成器
生成是准备标记源文件后的第二步。 这一步要么运行 TechDocs 容器(定义见下文)，要么运行mkdocsCLI 生成静态 HTML 文件及其资产。
TechDocs 出版商
发布是准备和生成文档后的第三步 ，也是最后一步。 TechDocs Publisher 会将生成的文件上传到存储空间。
techdocs-backend插件目前有两个发布者：谷歌云存储和本地文件系统。 你可以在Backstage应用中对它们进行配置。参见此处.
TechDocs 发布者负责两件事(TechDocs 发布者与用户之间的双向交流)。techdocs-backend和存储)
将生成的静态文件发布到存储区(由 techdocs.builder 配置) 2. 当用户访问 TechDocs 站点时从存储区读取文件
技术文档构建策略
为了适应围绕是否构建 TechDocs 的更复杂逻辑，TechDocs 后端支持选择构建策略。 构建策略负责决定所请求的文档是否应由 TechDocs 后端在本地构建。 对构建策略进行自定义，可以根据实体的具体情况，就是否由 TechDocs 后端负责构建 TechDocs、是否由外部流程负责构建 TechDocs、或是否由本地构建和外部流程的组合负责构建 TechDocs，实现更复杂的行为。
默认的构建策略会导致 TechDocs 后端在本地构建文档，如果techdocs.builder配置选项设置为'local'然而，任何满足 "构建策略 "接口的逻辑都可以实现，使用Backstage配置以及正在处理的实体来做出决定。
有关如何使用 "构建策略 "实施 "混合 "构建模式的示例，请参考如何实施混合构建战略指导。
TechDocs Container
TechDocs 容器是一个 Docker 容器，可从以下网址获取DockerHub它通过 MkDocs 从 Python 风格的 Markdown 生成静态 HTML 页面，包括样式表和脚本。
TechDocs 核心插件
TechDocs 核心插件是一个MkDocs插件是作为多个 MkDocs 插件和 Python Markdown 扩展的封装程序而创建的，目的是将 TechDocs 所使用的 MkDocs 配置标准化。
TechDocs CLI
创建 TechDocs CLI 的目的是为了方便编写、生成和预览用于发布的文档。 目前，它主要充当 TechDocs 容器的包装器，并为我们的 docker 容器提供一个易于使用的界面。
TechDocs 阅读器
TechDocs 生成的文档是以静态 HTML 网站的形式生成的。 因此，TechDocs 阅读器的创建是为了能够将预先生成的 HTML 网站与Backstage用户界面集成在一起。
变形金刚
转换器是 TechDocs 阅读器内部使用的不同功能。 引入转换器的原因是为了提供一种在渲染前和渲染后转换 HTML 内容的方法(例如重写文档链接或修改 css)。
TechDocs 附加组件
附加组件(在 Backstage v1.2 中引入)是基于 React 的客户端扩展，可用于在阅读时增强 TechDocs 体验。 它们提供了一种配置 TechDocs 阅读器的机制，以更好地满足您组织的需求。
附加组件可以在 TechDocs 阅读器的任何位置动态加载和显示信息，包括静态生成的内容本身。
附加组件不应与mkdocs插件，可以在构建时自定义 TechDocs 网站的内容。mkdocs插件提供了另一种选择。