https://github.com/dbots-pkg/action-docs

Action that generates website docs for branches and tags using docgen
https://github.com/dbots-pkg/action-docs

Last synced: about 1 year ago
JSON representation

Action that generates website docs for branches and tags using docgen

• Host: GitHub
• URL: https://github.com/dbots-pkg/action-docs
• Owner: dbots-pkg
• License: mit
• Created: 2020-04-06T12:52:43.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T21:35:54.000Z (almost 3 years ago)
• Last Synced: 2025-01-31T07:45:04.448Z (over 1 year ago)
• Language: TypeScript
• Size: 168 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# action-docs

Action that generates website docs for branches and tags using docgen

## Usage

**Imporant:** this action requires the `docs/docs.json` file to be built **before** the action is run.

How to use it in a workflow:

```yaml

- run: npm run docs

- uses: dbots-pkg/action-docs@v1

  env:

    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```

## License

This actions is distributed under the MIT license, check the [license file](LICENSE) for more info.