TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-18 18:14:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

Add some build info to README

Browse Source
This commit is contained in:
Bjørn Erik Pedersen 2017-07-18 10:54:47 +02:00
parent b0470688f1
commit cfe751dbf5
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -2,12 +2,17 @@
Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in GoLang.
## Branches
## Build
* The `master` branch is the **current Hugo version** and will be auto-deployed to [gohugo.io/](https://gohugo.io/).
* Anything not relevant to the current Hugo version goes into the `dev` branch.
* Changes in [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs) will, in general, be merged once every release, but can be manually merged/cherry picked if needed. This goes both ways.
* All contributions that is not tightly coupled with code changes, should be made directly to `hugoDocs`.
* But we also merge PRs into [hugo/docs](https://github.com/gohugoio/hugo/tree/master/docs), but preferably changes that is related to the code in the PR itself
To view the documentation site locally, you need to clone this repository with submodules:
To summarize, we have two branches in this repository: `master` (current Hugo) and `dev` (next Hugo).
```bash
git clone --recursive https://github.com/gohugoio/hugoDocs.git
```
Or if you already have a clone locally:
```bash
git submodule update --init
```
Also note that the documentation version for a given version of Hugo can also be found in the `/docs` sub-folder of the [Hugo source repository](https://github.com/gohugoio/hugo).