README Env Table Sync

README Env Table Sync是什么

README Env Table Sync 是一款用于自动同步 README 文件中环境变量表的工具，通过解析 .env.example 文件生成 Markdown 表格，并支持在持续集成环境中检测文档漂移。

由 daniellummis 开发 | 累计安装 84 次 | 开源协议：MIT-0

README Env Table Sync的主要功能

• 自动同步：从 .env.example 文件自动生成 README 中的环境变量表。
• 漂移检测：在 CI 环境下检测 README 文档与 .env.example 文件的差异。
• 标记块更新：支持通过标记块在 README 中定位和更新环境变量表。
• 可选应用：可选将更新直接应用到 README 文件中。
• 本地执行：仅通过本地文件访问，无需网络请求或外部凭证。

如何使用README Env Table Sync

• 设置环境文件：指定 .env.example 文件路径（默认为 .env.example）。
• 指定 README 文件：指定 README 文件路径（默认为 README.md）。
• 选择同步模式：选择 'report' 模式生成报告或 'apply' 模式直接应用更新。
• 设置标记块：可选设置表格开始和结束的标记块（默认为 和 ）。
• 运行脚本：执行脚本进行环境变量表的同步和漂移检测。

README Env Table Sync的项目地址

• 项目官网：https://clawhub.ai/daniellummis/readme-env-table-sync

README Env Table Sync的应用场景

• 持续集成环境中自动同步环境变量表，确保文档与实际配置一致。
• 在项目更新时自动更新 README 中的环境变量信息，提高文档的准确性。
• 在多环境部署时，快速同步不同环境下的环境变量配置。