diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2017-08-10 17:17:07 +0200 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2017-08-10 17:17:07 +0200 |
commit | d384c661fef16fcfb5551db4cc1a2e60fb7cbed2 (patch) | |
tree | 3e38bf24c84ad55145d31d9a3a082206352b46e2 /docs/README.md | |
parent | 9a2eb0f1d3f731609767c8043664dad0a0d72b6a (diff) |
docs: Re-integrate
Diffstat (limited to 'docs/README.md')
-rw-r--r-- | docs/README.md | 40 |
1 files changed, 0 insertions, 40 deletions
diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index c482ff630..000000000 --- a/docs/README.md +++ /dev/null @@ -1,40 +0,0 @@ -# Hugo Docs - -Documentation site for [Hugo](https://github.com/gohugoio/hugo), the very fast and flexible static site generator built with love in GoLang. - -## Contributing - -We welcome contributions to Hugo of any kind including documentation, suggestions, bug reports, pull requests etc. Also check out our [contribution guide](https://gohugo.io/contribute/documentation/). We would love to hear from you. - -Note that this repository contains solely the documentation for Hugo. For contributions that aren't documentation-related please refer to the [hugo](https://github.com/gohugoio/hugo) repository. - -*Pull requests shall **only** contain changes to the actual documentation. However, changes on the code base of Hugo **and** the documentation shall be a single, atomic pull request in the [hugo](https://github.com/gohugoio/hugo) repository.* - - -## Build - -To view the documentation site locally, you need to clone this repository with submodules: - -```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). - -Then to view the docs in your browser, run Hugo and open up the link: - -```bash -▶ hugo server - -Started building sites ... -. -. -Serving pages from memory -Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) -Press Ctrl+C to stop -``` |