mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00

The world’s fastest framework for building websites.

blog-engine cms content-management-system documentation-tool go hugo static-site-generator

Find a file

Bjørn Erik Pedersen 2c0d1ccdcd Squashed 'docs/' changes from b0470688..73f355ce 73f355ce Update theme 83ff50c2 Use example.com in examples 71292134 Add alias news > release-notes 2e15f642 Update theme 8eef09d2 Add Pygments configuration 572b9e75 Clean up the code shortcode use a1b2fd3b Remove the code fence language codes 1473b1d9 Remove redundant text b92c2042 Update theme 8f439c28 Edit contributing section in README 8bcf8a19 Add contributing section to README 4c44ee1c Fix broken content file 2bdc7710 Clarify .Data.Pages sorting in lists.md 092271c2 Use infinitive mood for main titles b9b8abef Update theme to reflect change to home page content b897b71b Change copy to use sentence case fd675ee5 Enable RSS feed for sections 060a5e27 Correct movie title in taxonomies.md 6a5ca96a Update displayed site name for Hub 22f4b7a4 Add example of starting up the local server d9612cb3 Update theme a8c3988a Update theme 4198189d Update theme 12d6b016 Update theme 2b1c4197 Update theme b6d90a1e Fix News release titles cfe751db Add some build info to README git-subtree-dir: docs git-subtree-split: 73f355ce0dd88d032062ea70067431ab980cdd8d		2017-07-21 11:00:08 +02:00
archetypes	Squashed 'docs/' changes from f3c88b08..b0470688	2017-07-18 10:24:26 +02:00
content	Squashed 'docs/' changes from b0470688..73f355ce	2017-07-21 11:00:08 +02:00
data	Squashed 'docs/' changes from f3c88b08..b0470688	2017-07-18 10:24:26 +02:00
layouts/shortcodes	Squashed 'docs/' changes from b0470688..73f355ce	2017-07-21 11:00:08 +02:00
static	Squashed 'docs/' changes from f3c88b08..b0470688	2017-07-18 10:24:26 +02:00
temp	Squashed 'docs/' content from commit 5d9a6703	2017-06-26 20:46:06 +02:00
themes	Squashed 'docs/' changes from b0470688..73f355ce	2017-07-21 11:00:08 +02:00
.gitignore	Squashed 'docs/' content from commit 5d9a6703	2017-06-26 20:46:06 +02:00
.gitmodules	Squashed 'docs/' changes from f3c88b08..b0470688	2017-07-18 10:24:26 +02:00
config.toml	Squashed 'docs/' changes from b0470688..73f355ce	2017-07-21 11:00:08 +02:00
LICENSE.md	Squashed 'docs/' changes from f3c88b08..b0470688	2017-07-18 10:24:26 +02:00
netlify.toml	Squashed 'docs/' changes from f3c88b08..b0470688	2017-07-18 10:24:26 +02:00
README.md	Squashed 'docs/' changes from b0470688..73f355ce	2017-07-21 11:00:08 +02:00
requirements.txt	Squashed 'docs/' changes from b0470688..73f355ce	2017-07-21 11:00:08 +02:00

README.md

Hugo Docs

Documentation site for 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. 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 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 repository.

Build

To view the documentation site locally, you need to clone this repository with submodules:

git clone --recursive https://github.com/gohugoio/hugoDocs.git

Or if you already have a clone locally:

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.

Then to view the docs in your browser, run Hugo and open up the link:

hugo serve
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