1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-04-09 01:20:58 +00:00
The world’s fastest framework for building websites.
Find a file
Bjørn Erik Pedersen 83bef6955e Squashed 'docs/' changes from 896bad9f4..e161ea09d
e161ea09d Add one more Chinese file to workaround reflect: Zero(nil)
b595b3a21 Add more Chinese translation
56e4e95d9 Use lang.Merge to "fill in the gaps" for untranslated pages
ef079406c Merge commit '650fac3a4e7d256f4505402ab44cfc3c804b8dea'
650fac3a4 Squashed 'themes/gohugoioTheme/' changes from a1768ebb..f31a3dc8
322eff899 Add Chinese language for menus
d90b886e0 Fix Markdown table syntax in previous commit
737f3dfca Update the leaf bundle vs branch bundle table
09fa1bc4e Clarify that `.Now` is obsolete
879ea3f6a Make release notes somewhat more consistent
0113e2051 Move 0.40.2-relnotes into content/en/news
77578f5bf Move content/ into new contentDir content/en/
4dcf7c709 Fix "reflect: Zero(nil)" error in showcase
63dd25505 Release 0.40.2
2076c0d56 releaser: Prepare repository for 0.41-DEV
070fe565e releaser: Add release notes to /docs for release of 0.40.2
4ce52e913 releaser: Bump versions for release of 0.40.2
41907c487 Fix typos in syntax-highlighting.md
91753ef3d Add missing backtick
b77274301 Remove duplicate release notes (0.27, 0.27.1, 0.35)
6e00da316 Remove obsolete content/release-notes/ directory
00a6d8c02 Change en dash back to `--` in 0.38.2-relnotes
51b32dc00 Update archetypes.md
d0e5c2307 Release 0.40.1
4538a6d5b releaser: Prepare repository for 0.41-DEV
91b391d70 releaser: Add release notes to /docs for release of 0.40.1
e0979d143 releaser: Bump versions for release of 0.40.1
7983967c2 Clean images
fe3fdd77d Polish showcase for Flesland Flis
e6dde3989 Showcase - Flesland Flis AS by Absoluttweb
73aa62290 Revive @spf13's special Hugo font
add67b335 Release Hugo 0.40
c0a26e5a6 Merge branch 'temp40'
beeabaaae releaser: Prepare repository for 0.41-DEV
e67d5e985 releaser: Add release notes to /docs for release of 0.40
6cdd95273 releaser: Bump versions for release of 0.40
bee21fb9b Revive the other Hugo logos too
4f45e8fe1 Fix the link type attribute for RSS in examples
8c67dc89a Fix example in delimit doc
e7f6c00d5 Revive the logo used on the forum
82b0cd26e Merge commit 'a215abf70e018f4bf40d6c09d8bd148d8684b33d'
119c8ca58 Merge commit 'd2ec1a06df8ab6b17ad05cb008d5701b40327d47'
db4683bd2 Improve .Get docs
05260b886 .Get function: fix syntax signature

git-subtree-dir: docs
git-subtree-split: e161ea09d33e3199f4998e4d2e9068d5a850f042
2018-05-04 09:44:21 +02:00
archetypes Squashed 'docs/' changes from 56c34962c..dce236ad1 2018-01-31 11:07:47 +01:00
content Squashed 'docs/' changes from 896bad9f4..e161ea09d 2018-05-04 09:44:21 +02:00
data Squashed 'docs/' changes from f9a5dc59b..76e881257 2018-04-21 23:01:55 +02:00
layouts Squashed 'docs/' changes from d9c8fc220..f9a5dc59b 2018-04-16 07:43:59 +02:00
resources/_gen/images Squashed 'docs/' changes from 896bad9f4..e161ea09d 2018-05-04 09:44:21 +02:00
src Squashed 'docs/' changes from 2fc775dec..f97826a17 2018-02-10 12:51:31 +01:00
static Squashed 'docs/' changes from 896bad9f4..e161ea09d 2018-05-04 09:44:21 +02:00
themes/gohugoioTheme Squashed 'docs/' changes from 896bad9f4..e161ea09d 2018-05-04 09:44:21 +02:00
.gitignore Squashed 'docs/' changes from 2fc775dec..f97826a17 2018-02-10 12:51:31 +01:00
config.toml Squashed 'docs/' changes from 896bad9f4..e161ea09d 2018-05-04 09:44:21 +02:00
LICENSE.md Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00
netlify.toml Squashed 'docs/' changes from 896bad9f4..e161ea09d 2018-05-04 09:44:21 +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 715741f73..4e7e1815b 2018-03-11 20:39:20 +01:00
requirements.txt Squashed 'docs/' content from commit f887bd7b 2017-08-10 17:18:22 +02:00

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.

Spelling fixes are most welcomed, and if you want to contribute longer sections to the documentation, it would be great if you had these in mind when writing:

  • Short is good. People go to the library to read novels. If there is more than one way to do a thing in Hugo, describe the current best practice (avoid "… but you can also do …" and "… in older versions of Hugo you had to …".
  • For examples, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great, but don't list long and similar examples just so people can use them on their sites.
  • Hugo has users from all over the world, so an easy to understand and simple English is good.

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