bcc-code/Build and Deploy Documentation Site
Convert Markdown documentation to a BCC documentation site
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Maintainedlast commit Jan 13, 2026
- License
- None
Pinned Snippet
uses: bcc-code/bcc-developer-docs-deploy@7752f7e1f28cd0434ed5a18d936385187922e576 # v1tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| title | Title of the generated website | yes | ${{ github.event.repository.name }} |
| description | Description of the generated website, used for the head meta tag | yes | ${{ github.event.repository.description }} |
| docs-dir | Directory where the docs are located | no | docs |
| branch | Which branch to use for "Edit this page on GitHub" links | no | main |
| base | The base url for the website | no | / |
| collapse-sidebar | Whether to collapse sidebar sections by default | no | false |
| auto-register-components | Whether to automatically register Vue components | no | false |
| components-dir | The directory from where Vue components should automatically be registered | no | src/components |
| debug-build | Whether or not to enable debugging for the Vite build | no | false |
| public | Whether or not to make the documentation publicly available (only works for private repositories) | no | false |
| authentication | Which provider to use for the login flow when accessing the documentation | no | github |
| root | Whether or not to deploy the site to the root of the custom container (true) or to a subfolder named after the repository (false) | no | false |
| pat | Personal Access Token for authentication | yes | — |
| env | Environment to deploy to (sandbox, prod) | no | prod |
Outputs
no outputs