Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #12262

Merged
merged 1 commit into from
Nov 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,37 @@ The docsite is generated using [Hugo](https://gohugo.io/) and hosted using Githu

To view locally:

1. Install Hugo v0.136.5
1. Ensure you've installed [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git),
[Go](https://go.dev/doc/install), and [Dart Sass](https://gohugo.io/hugo-pipes/transpile-sass-to-css/#dart-sass).
You require these prerequisites for installing Hugo.

1. Install Hugo v0.136.5:
```bash
CGO_ENABLED=1 go install -tags extended github.com/gohugoio/[email protected]
```
2. Run `hugo server` inside the `docs` directory
3. Visit http://localhost:1313/magic-modules/ to view the docs

1. Restart your terminal.

1. Clone the `magic-modules` GitHub repository:
```bash
git clone https://github.com/GoogleCloudPlatform/magic-modules.git
```
1. Navigate to the `docs` directory inside the `magic-modules` repository:
```bash
cd magic-modules/docs/
```

1. Start Hugo's development server to view the Magic Modules site:
```bash
hugo server
```

1. View the docs by visiting the following URL in a browser window:
```bash
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`
Expand Down
Loading