☰ 菜单
首页›命令行工具›action-docs
命令行 开源 8 次安装/月

action-docs for Mac 版

action-docs

为 GitHub Actions 生成文档

action-docs 是什么

action-docs 是一个命令行工具,用来根据 action.yml 定义文件生成和更新 GitHub Actions 或 workflow 的文档。它的核心思路是让文档跟着配置走:在 README 中插入特定注释块后,运行 `action-docs -u` 就能自动更新名称标题、描述、输入、输出、用法和 runs 等章节,避免手动维护文档与 action 定义脱节。除了默认的 action.yml,也可以通过 `-s` 选项或标签中的 `source` 属性指定其他 action 文件;需要更新其他 Markdown 文件时,在命令后加上文件名即可。它还支持将生成的 Markdown 文档直接打印到控制台,方便预览或复制。如果希望在 GitHub workflow 中自动完成 README 更新,可以配合 action-docs-action 使用。这个工具适合维护 GitHub Actions 的开发者,尤其是 action 输入输出经常变动、又不想反复手改 README 的团队。项目采用 MIT 许可证,欢迎贡献。

如何安装 action-docs

  1. 打开 终端(按 ⌘ + 空格,输入“终端”)。
  2. 如果还没安装 Homebrew,先运行下面这条安装命令。
  3. 运行下面这条命令:

最近 10 个版本记录

最近一次更新为 2024-11-10,当前版本 v2.5.1,共记录最近 10 个版本。

版本发布日期类型大小macOSWindowsLinux
v2.5.12024-11-10稳定版————
v2.5.02024-10-12稳定版————
v2.4.32024-09-03稳定版————
v2.4.22024-07-03稳定版————
v2.4.12024-04-27稳定版————
v2.4.02024-03-13稳定版————
v2.3.02024-03-09稳定版————
v2.2.02024-03-06稳定版————
v2.1.02024-02-16稳定版————
v2.0.12024-02-14稳定版————

数据来自 GitHub Releases,稳定版优先,同类按发布时间排序。

二进制包支持平台

Homebrew 官方提供的预编译包(bottle)覆盖:

  • all

⚠️ 未提供 Intel Mac 的预编译包,Intel 机型需要通过 brew install --build-from-source 从源码编译。

与同类应用对比

只对比公开元数据,不做主观推荐;需要逐项对比时见对比页。

与同类应用对比
应用版本许可证架构近 30 天安装
action-docsv2.5.1MIT命令行8
cobra-cliv1.3.0Apache-2.0命令行2
tygov0.2.21MIT命令行2
swiftplantuml0.8.1MIT命令行2

命令行工具中的类似应用

发表评论

评论表单加载中…