Skip to content

Commit

Permalink
Merge pull request #6 from alexearnshaw/build_instructions
Browse files Browse the repository at this point in the history
update instruction order and github link
  • Loading branch information
Alex Earnshaw authored Jul 9, 2019
2 parents 50c9ea0 + f6ba3d3 commit 582bee3
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions content/docs/Contribution guidelines/setup_work_locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ If you are a maintainer of this documentation site, or a contributor who will be
* You will need a Git client installed, such as Gitbash
* You will need write access to the Git repo

## Clone the Git repo

Clone the git repo. Don't forget to use `--recurse-submodules` or you won't pull down some of the code you need to generate a working site.

```
git clone --recurse-submodules --depth 1 https://github.com/alexearnshaw/improve-the-docs.git
```


## Install Hugo

You need a [recent version](https://github.com/gohugoio/hugo/releases) of Hugo to build and run the site. If you install from the release page, make sure to get the `extended` Hugo version, which supports SCSS: you may need to scroll down the list of releases. Hugo can be installed via Brew if you're running MacOs. If you're a Linux user, do not use `sudo apt-get install hugo`, as it currently doesn't get you the `extended` version.
Expand All @@ -28,14 +37,6 @@ npm install -D --save autoprefixer
npm install -D --save postcss-cli
```

## Clone the Git repo

Clone the git repo. Don't forget to use `--recurse-submodules` or you won't pull down some of the code you need to generate a working site.

```
git clone --recurse-submodules --depth 1 [email protected]:alexearnshaw/improve-the-docs.git
```

## Build the site locally

Run the `hugo server` command in your site root.
Expand Down

0 comments on commit 582bee3

Please sign in to comment.