YAML 是 DevOps、Kubernetes 和 CI/CD 流水线的配置语言,但 YAML 配置在文档中难以阅读。将 YAML 数组转换为 Markdown 表格,让相同数据一目了然。
支持的 YAML 结构
转换器接受两种 YAML 结构:具有相同键的映射序列(每个条目的键成为列标题);单个映射转换为带键/值列的两列表格,适合记录环境变量或配置项。
如果 YAML 包含嵌套对象,嵌套值会以内联 YAML 字符串形式序列化在单元格中。
文档工作流
常见工作流:以 YAML 文件维护配置结构,转换为 Markdown 纳入 README,以 YAML 为单一数据源。更新 YAML 后重新生成 Markdown。
这样可以让文档与配置保持同步,无需维护两份独立文件。