github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
The world’s fastest framework for building websites.
13 commits 140 branches 302 tags 202 MiB
Go 95.9%
JavaScript 3.1%
HTML 0.9%
Find a file
Bjørn Erik Pedersen 30c0d485ea Squashed 'docs/' changes from a042b67b5..3e663efb2 
3e663efb2 Add poster for Hugo 0.31 release
b3c98ba65 Add doc about the new static dir support
2e62e4bdf Update multilingual docs for Hugo 0.31
8eff394b3 commands: Regenerate

git-subtree-dir: docs
git-subtree-split: 3e663efb2b149e243b6ecfdc439a2a2be573987f
2017-11-20 11:19:16 +01:00
archetypes Squashed 'docs/' changes from 44fe0285..32356e4e 2017-09-21 19:03:00 +02:00
content Squashed 'docs/' changes from a042b67b5..3e663efb2 2017-11-20 11:19:16 +01: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 a042b67b5..3e663efb2 2017-11-20 11:19:16 +01: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 e65df1059..a042b67b5 2017-11-17 13:46:40 +01:00
LICENSE.md Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
netlify.toml Squashed 'docs/' changes from e65df1059..a042b67b5 2017-11-17 13:46:40 +01: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