@google-cloud/cloud-rad

中文文档
0.4.12发布于 2026/09/30Apache-2.0CommonJS近 30 天下载 1.2万

Helper tool to generate documentation for Nodejs client libraries and upload them to https://cloud.google.com/nodejs/docs/reference.

原始使用文档

nodejs-cloud-rad

Helper tool to generate documentation for Nodejs client libraries and upload them to https://cloud.google.com/nodejs/docs/reference.

Run locally

Inside a client library, run:

npm install
npm install --no-save https://github.com/googleapis/nodejs-cloud-rad#main

npx @google-cloud/cloud-rad 

Set NO_UPLOAD=1 to generate the docfx yaml without attempting to upload to Cloud RAD.

Ignore the warnings about pip. There should be a _devsite folder with yaml files. Install docfx. Clone https://github.com/googleapis/doc-templates outside of the client library.

Create the following docfx.json file inside the client library:

{
  "build": {
    "content": [
      {
        "files": ["**/*.yml"],
        "src": "_devsite/",
        "dest": "api"
      }
    ],
    "dest": "_site",
    "template": [
      "/absolute path to/doc-templates/third_party/docfx/templates/devsite"
    ]
  } 
}

Run docfx --serve. You should see docs without CSS styling on localhost:8080/api.

版本与发布记录

@google-cloud/cloud-rad 共发布 119 个版本,首次发布于 2021/06/07;过去 12 个月发布了 2 个版本。

版本发布日期距今
0.4.12latest2026/09/301 个月前
0.4.112026/09/162 个月前
0.4.102025/06/181.4 年前
0.4.10-debugdebug2025/06/181.4 年前
0.4.92025/06/181.4 年前
0.4.82024/10/052 年前

其他发布通道:experimental → 0.4.19-experimental,debug → 0.4.10-debug。

关于 @google-cloud/cloud-rad 的常见问题

@google-cloud/cloud-rad 是什么?

Helper tool to generate documentation for Nodejs client libraries and upload them to https://cloud.google.com/nodejs/docs/reference.

如何安装 @google-cloud/cloud-rad?

在项目目录运行 npm install @google-cloud/cloud-rad,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cloud-rad,可以用 npx cloud-rad 直接运行。

@google-cloud/cloud-rad 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/google-cloud__cloud-rad 是否存在。

@google-cloud/cloud-rad 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@google-cloud/cloud-rad 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=12.0.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@google-cloud/cloud-rad 可以商用吗?

@google-cloud/cloud-rad 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@google-cloud/cloud-rad 的下载量有多少?

根据 npm 官方下载统计,@google-cloud/cloud-rad 在 2026/10/17 – 2026/11/15 这 30 天内被下载 11,712 次,日均约 390 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@google-cloud/cloud-rad 还在维护吗?

最新版本 0.4.12 发布于 2026/09/30(1 个月前);至今共发布 119 个版本,其中过去 12 个月发布了 2 个;首次发布于 2021/06/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。