bcc-code/Build and Deploy Documentation Site

Convert Markdown documentation to a BCC documentation site

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
titleTitle of the generated websiteyes${{ github.event.repository.name }}
descriptionDescription of the generated website, used for the head meta tagyes${{ github.event.repository.description }}
docs-dirDirectory where the docs are locatednodocs
branchWhich branch to use for "Edit this page on GitHub" linksnomain
baseThe base url for the websiteno/
collapse-sidebarWhether to collapse sidebar sections by defaultnofalse
auto-register-componentsWhether to automatically register Vue componentsnofalse
components-dirThe directory from where Vue components should automatically be registerednosrc/components
debug-buildWhether or not to enable debugging for the Vite buildnofalse
publicWhether or not to make the documentation publicly available (only works for private repositories)nofalse
authenticationWhich provider to use for the login flow when accessing the documentationnogithub
rootWhether or not to deploy the site to the root of the custom container (true) or to a subfolder named after the repository (false)nofalse

no outputs