@google-cloud/cloud-rad NPM | npm.io

0.4.1-experimental • Published 3 years ago

Install

Weekly downloads

-

License

Apache-2.0

Repository

Last release

3 years ago

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.

@microsoft/api-extractor @googleapis/api-documenter

@infinitebrahmanuniverse/nolb-_goo @everything-registry/sub-chunk-369 @zalastax/nolb-_goo

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

0.4.19-experimental

3 years ago

3 years ago

0.4.9-experimental

3 years ago

3 years ago

0.4.15-experimental

3 years ago

0.4.7-experimental

3 years ago

0.4.17-experimental

3 years ago

3 years ago

3 years ago

0.4.13-experimental

3 years ago

3 years ago

0.4.11-experimental

3 years ago

0.4.4-experimental

3 years ago

0.4.10-experimental

3 years ago

0.3.8-experimental

3 years ago

0.4.5-experimental

3 years ago

0.3.9-experimental

3 years ago

0.3.7-experimental

3 years ago

0.4.6-experimental

3 years ago

3 years ago

0.4.3-experimental

3 years ago

0.4.0-experimental

3 years ago

0.4.2-experimental

3 years ago

0.4.1-experimental

3 years ago

3 years ago

3 years ago

0.3.4-experimental

3 years ago

0.3.3-experimental

3 years ago

0.3.5-experimental

3 years ago

0.3.6-experimental

3 years ago

0.3.1-experimental

3 years ago

0.3.2-experimental

3 years ago

0.3.0-experimental

3 years ago

3 years ago

0.4.18-experimental

3 years ago

3 years ago

3 years ago

0.4.14-experimental

3 years ago

0.4.16-experimental

3 years ago

0.4.8-experimental

3 years ago

3 years ago

0.4.12-experimental

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago