The docsite is generated using Hugo and hosted using Github Pages. The theme is Hugo Book by Alex Shpak. Magic Modules documentation should adhere to the Google developer documentation style guide.
To view locally:
- Install Hugo
- Run
hugo server
inside thedocs
directory - Visit http://localhost:1313/magic-modules/ to view the docs
If you are having deployment issues, try to reset your hugo module cache.
hugo mod clean
To upgrade the theme version:
- find the version you want at https://github.com/alex-shpak/hugo-book/commits/master
- Run the following
go get github.com/alex-shpak/hugo-book@{{commit_hash}}
## example
## go get github.com/alex-shpak/hugo-book@d86d5e70c7c0d787675b13d9aee749c1a8b34776