mirror of https://github.com/gohugoio/hugo.git synced 2024-07-04 16:21:57 +00:00

The world’s fastest framework for building websites.

Go to file

Bjørn Erik Pedersen ecf5e081b5 Squashed 'docs/' changes from 000ab7c42..4628b9ec2 4628b9ec2 commands: Regen CLI doc 2525f2ed0 data: Regenerate docs helper 6f5a0eb19 Add Hugo 0.30 poster image 72c3fac9e Merge branch 'chroma-next2' into next 364973d3f Fix typo in syntax highlighting. ce10cc02e Update Chroma highlighting docs 9dcc4d4dd Update robots.md 1e64cb483 Rename title of cross references' page d6dfbbc51 Add warning about MMark and TOCs e8d259d32 Fix link to subsection in page 6adead19d Merge commit '040d8d2833c26c53cf9f0e035910821ed50e3863' 040d8d283 Squashed 'themes/gohugoioTheme/' changes from cdaa89c8..6b632895 bde95d890 Add Atlas starter kit fc40d078d Remove page arg from examples of relref shortcode c578620b5 Remove page arg from examples of ref shortcode ee81931a4 Remove delimiters in YAML and TOML config examples 62d7b269f Clarify that .Lastmod automatically uses .GitInfo.AuthorDate (#226) git-subtree-dir: docs git-subtree-split: 4628b9ec2c52df4de673a4d6b9621a65d8e8f5a4		2017-10-15 10:20:55 +02:00
archetypes	Squashed 'docs/' changes from 44fe0285..32356e4e	2017-09-21 19:03:00 +02:00
content	Squashed 'docs/' changes from 000ab7c42..4628b9ec2	2017-10-15 10:20:55 +02:00
data	Squashed 'docs/' changes from 000ab7c42..4628b9ec2	2017-10-15 10:20:55 +02:00
layouts/shortcodes	Squashed 'docs/' changes from 36d7e22f5..000ab7c42	2017-10-04 09:27:29 +02:00
src/css	Squashed 'docs/' changes from 1662b9d0..20959c7b	2017-09-25 09:02:42 +02:00
static	Squashed 'docs/' changes from 000ab7c42..4628b9ec2	2017-10-15 10:20:55 +02:00
themes/gohugoioTheme	Squashed 'docs/' changes from 000ab7c42..4628b9ec2	2017-10-15 10:20:55 +02:00
.gitignore	Squashed 'docs/' changes from 20959c7b..36d7e22f	2017-09-28 17:20:10 +02:00
.gitmodules	Squashed 'docs/' content from commit f887bd7b	2017-08-10 17:18:22 +02:00
config.toml	Squashed 'docs/' changes from 20959c7b..36d7e22f	2017-09-28 17:20:10 +02:00
LICENSE.md	Squashed 'docs/' content from commit f887bd7b	2017-08-10 17:18:22 +02:00
netlify.toml	Squashed 'docs/' changes from 20959c7b..36d7e22f	2017-09-28 17:20:10 +02:00
pull-theme.sh	Squashed 'docs/' content from commit f887bd7b	2017-08-10 17:18:22 +02:00
README.md	Squashed 'docs/' changes from 1662b9d0..20959c7b	2017-09-25 09:02:42 +02:00
requirements.txt	Squashed 'docs/' content from commit f887bd7b	2017-08-10 17:18:22 +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.

Branches

The master branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version.
The next branch is where we store changes that is related to the next Hugo release. This can be previewed here: https://next--gohugoio.netlify.com/

Build

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

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

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