macOS
Homebrew已验证 · 100%
brew install action-docslocal Homebrew formula metadata
安装
其他安装命令
概览
软件包摘要
Generate docs for GitHub actions
历史
项目历史与用法
action-docs is a Node.js CLI and library that generates and updates Markdown documentation for GitHub Actions and workflows from action.yml-style metadata.
项目历史
The repository was created in 2021, and the official releases begin with 1.0.0 in March 2021. Its README frames the tool around keeping README sections synchronized with GitHub action or workflow definitions.
采用历史
The README advertises npm installation, CLI use, README update markers, a JavaScript API, and a companion GitHub Action. That adoption path matches the GitHub Actions ecosystem: project authors can run the CLI locally, in npm workflows, or through automation.
使用方式
Users add action-docs HTML comment markers to Markdown files, then run action-docs to print generated docs or action-docs --update-readme to update files in place. Options cover source action/workflow files, table-of-contents level, line breaks, and custom README targets.
为什么软件包爱好者会关心
action-docs matters to package-manager users because it turns GitHub Actions metadata into reproducible documentation output, a small automation task that fits naturally into npm scripts, Homebrew-installed CLIs, and repository maintenance workflows.
时间线
- 2021-02-20: GitHub repository created.
- 2021-03-07: 1.0.0 release published.
- 2024-02-04: 2.0.0 release published.
- 2024-11-10: 2.5.1 release published.
Related projects
- Related projects include GitHub Actions documentation generators, README updaters, markdown automation tools, and npalm/action-docs-action.
来源
安全态势
风险级别：绿色
narrow executable package without higher-risk signals.
风险分类器
绿色 风险 · 低 置信度 · appliance
原因
- narrow executable package without higher-risk signals
信号
- metadata:no-higher-risk-signals
安装行为
- formula 元数据中未记录 Homebrew post-install 钩子。
- Homebrew bottle 元数据适用于 1 个平台目标。
- 安装时包含 1 个运行时依赖。
建议审查
在无人值守的代理使用前，请检查该工具是否读取明文凭据、写入远程状态、发布制品或调用插件。
可执行文件
已安装的可执行文件
| 命令 | 类型 | 暴露范围 | 备注 |
|---|---|---|---|
action-docs | cli | 全局可执行文件 |
新鲜度
版本和新鲜度
这些信号区分页生成时间、软件包管理器活动和上游发布比较。只有存在证据 URL 和可比较版本时，才会提示版本落后。
页面生成时间2026-07-25
管理器版本2.5.1
管理器更新时间2026-05-26
本地数据OK
上游not checked
检测到的最新版本未检测到
https://github.com/npalm/action-docs
- 信息No cached GitHub release or tag data was available.https://github.com/npalm/action-docsnone 置信度
安装元数据
软件包元数据
| 软件包键 | brew:action-docs |
|---|---|
| 版本 | 2.5.1 |
| 软件包管理器 | Homebrew |
| 软件包管理器页面 | https://formulae.brew.sh/formula/action-docs |
| 主页 | https://github.com/npalm/action-docs |
| 仓库 | https://github.com/npalm/action-docs |
| 上游文档 | https://github.com/npalm/action-docs#readme |
| 许可证 | MIT |
| 源码归档 | https://registry.npmjs.org/action-docs/-/action-docs-2.5.1.tgz |
| 最后更新 | 2026-05-26T23:37:47-04:00 |
| Pulse | updated |
| 依赖 | node |
| Bottle | 可用 (于 all) |
| Homebrew post-install | 未定义 |
| 服务 | 未声明 |
注册表事实
源数据库详情
| Source Database | Homebrew formula API |
|---|---|
| Tap | homebrew/core |
| Full Name | action-docs |
| Version Scheme | 0 |
| Revision | 0 |
| Bottle Stable Root URL | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
来源线索
由仓库数据生成
此页面由 av-web 从 scripts/generate-pkg-sqlite.py 生成的私有软件包 SQLite 工件提供。
Combined YAML source
View the package source record on GitHub.
使用的来源
- Geiger risk classifier
- Nucleus package database
- av.db category and tag curation
- cross-ecosystem install command graph
- curated package history
- package relationship graph
- package version freshness
- package-page enrichment