azure-saas/docs/readme.md

1.4 KiB

Documentation for the site is generated using Hugo and Docksy. Hugo is a static site generator with Docksy providing a default theme and auto-generated navigation to make reviewing the documentation easier. These make use of structured Markdown (.md) files organized in nested directories to create a simple site. This site is built and deployed by a GitHub workflow action executing docs-build.yml. The site is deployed via the pages-build-deployment workflow.

Variable Section Description Default
github_token Deploy Secret token necessary to give the bot access to publish the document pages
publish_dir Deploy Path to published directory that will be deployed

Further Reading

Publishing a Hugo Site - Manual setup of a Hugo static pages on Azure GitHub Page Deploy - Documentation of GitHub functionality to automate page deployment