Skip to content

Commit

Permalink
chore: document fix for hugo module fail
Browse files Browse the repository at this point in the history
fixes #1048

License: MIT
Signed-off-by: Oli Evans <oli@tableflip.io>
  • Loading branch information
olizilla committed Aug 25, 2020
1 parent ef1c803 commit 3b597e7
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,17 @@ yarn serve
# open http://localhost:1313/ in the browser
```

### Solving Common problems

**Problem** - Site fails to build with an error that states it faled to download modules on macos

```
Error: failed to download modules: go command failed ...
```

**Solution** - run `npm run clean-modules` - the cache dir hugo uses can get corrupted, and this resets it. See [#1048](https://github.com/filecoin-project/specs/issues/1048)


### External modules
External modules should be added as [Hugo Modules](https://gohugo.io/hugo-modules/)
You can find examples in the `config.toml`
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"test": "echo \"Error: no test specified\" && exit 1",
"serve": "hugo server --bind=0.0.0.0 --disableFastRender",
"build": "hugo --gc --minify",
"clean-modules": "hugo mod clean && hugo mod tidy"
"clean-modules": "hugo mod clean --all && hugo mod tidy"
},
"author": "",
"license": "MIT",
Expand Down

0 comments on commit 3b597e7

Please sign in to comment.