Skip to content

DOC: Fix Hugo install instructions in README (issue #231) #241

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
May 19, 2020
Merged

DOC: Fix Hugo install instructions in README (issue #231) #241

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@

## Getting Started

To contribute to the website, you'll first need to install Hugo.
To contribute to the website, you'll first need to install the *extended
version* of Hugo.

https://gohugo.io/getting-started/quick-start/
The Hugo [install page](https://gohugo.io/getting-started/installing/) has
instructions for different platforms and installers; make sure you end up with
the extended version.

Hint: If you're on a Mac, you can run `brew install hugo`.
On Linux it may be easiest to pick up a tarball of the latest extended version
from the [release page](https://github.com/gohugoio/hugo/releases/) and
install it per https://gohugo.io/getting-started/installing/#install-hugo-from-tarball.

Next, clone this repository, and install the theme:

Expand All @@ -30,6 +35,13 @@ to run the hugo server with draft enabled.

after which the site should be served at http://localhost:1313.

You'll see
```
error: failed to transform resource: TOCSS: failed to transform "style.sass"
```
if you don't have the Hugo extended version.


## Using docker:

* Build the docker image:
Expand Down