Skip to content

Commit

Permalink
Add some README info about the docs repo
Browse files Browse the repository at this point in the history
  • Loading branch information
bep committed Jul 18, 2017
1 parent 73273d4 commit a2fb815
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,20 @@ Once the `get` completes, you should find your new `hugo` (or `hugo.exe`) execut
To update Hugo’s dependencies, use `go get` with the `-u` option.

go get -u -v github.com/gohugoio/hugo

## The Hugo Documentation

The Hugo documentation now lives in its own repository, see https://github.com/gohugoio/hugoDocs. But we do keep a version of that documentation as a `git subtree` in this repository. To build the sub folder `/docs` as a Hugo site, you need to clone this repo with submodules:

```bash
git clone --recursive git@github.com:gohugoio/hugo.git
```

Or after you have cloned it you can do:

```bash
git submodule update --init
```

## Contributing to Hugo

Expand Down

0 comments on commit a2fb815

Please # to comment.