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:

1. Ensure you've installed Git, Go, and Dart Sass. You require these prerequisites for installing Hugo.

2. Install Hugo v0.150.0:

   CGO_ENABLED=1 go install -tags extended github.com/gohugoio/hugo@v0.150.0

3. Restart your terminal.

4. Clone the magic-modules GitHub repository:

   git clone https://github.com/GoogleCloudPlatform/magic-modules.git

5. Navigate to the docs directory inside the magic-modules repository:

   cd magic-modules/docs/

6. Start Hugo's development server to view the Magic Modules site:

   hugo server

7. View the docs by visiting the following URL in a browser window:

   http://localhost:1313/magic-modules/

You can press Ctrl+C to stop Hugo's development server.

If you are having deployment issues, try to reset your hugo module cache.

• hugo mod clean

To upgrade the theme version:

1. Find the version you want at https://github.com/alex-shpak/hugo-book/releases
2. Run the following

   hugo mod get github.com/alex-shpak/hugo-book/${module_version}

   Example:

   hugo mod get github.com/alex-shpak/hugo-book/v12
   

   Or to get specific commit tagged with v12.0.0

   hugo mod get github.com/alex-shpak/hugo-book/v12@v12.0.0