-
Notifications
You must be signed in to change notification settings - Fork 167
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from alexearnshaw/build_instructions
update instruction order and github link
- Loading branch information
Showing
1 changed file
with
9 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
@@ -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. | ||
|