Skip to content

Commit 2fddeba

Browse files
update README with detailed Hugo installation instructions for macOS
1 parent a2afc03 commit 2fddeba

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,14 @@
88

99
To make changes to the website, open a pull request with your changes. The website is built using Hugo, so you can test your changes locally by doing the following:
1010

11-
1. [Install Hugo](https://gohugo.io/installation/) on your local machine.
11+
1. [Install Hugo](https://gohugo.io/installation/) on your local machine. On macOS, do not install with Homebrew directly, the latest version of Hugo is always installed and unfortunately this is not compatible with the Scientific Python theme submodule used by the website. You can instead install GO to then get the version of Hugo you need:
12+
- `brew install go`
13+
- `echo 'export PATH=$PATH:/Users/<username>/go/bin' >> ~/.zshrc`
14+
- `go install github.com/gohugoio/[email protected]`
15+
- `export PATH=$PATH:/Users/<username>/go/bin && hugo version`
1216
2. Clone this repository to your local machine.
1317
3. Navigate to the repository directory in your terminal.
1418
4. Run `git submodule init` then `git submodule update` to initialise and update the theme submodule.
15-
5. Run the command `hugo server` to start the local development server.
19+
- Install the Dart Sass compiler: `npm install -g sass-embedded`, which is required by the Scientific Python Hugo theme.
20+
5. Run the command `hugo server --disableFastRender` to start the local development server.
1621
6. Open your web browser and go to `http://localhost:1313` to see your changes in action.

0 commit comments

Comments
 (0)