mirror of
https://github.com/gohugoio/hugo.git
synced 2026-08-24 23:38:53 +00:00
Bjørn Erik Pedersen
13e64d7276
6b00298bbRemove outdated "related example"987f1e1cdFix dead links (#601)96287a20aAdd config option "summaryLength" (#600)ced7f2085Adjust Over showcasee334a6354Add new showcase: over10435b502Add warning about privacy options only work with internal templates (#525)48c6b0e4dMinor grammatical fix684670ebcAdd quote0e9fada52Improvements to taxonomy template examplese06c4bf73Add syntax highlighting; consistent 4-space indentationc1cb3f081Remove dead links for custom permalinks3e3aefd04Fix0a671bc375d65888685fix file name in 'Add Non-content Entries to a Menu' code toggle (#547)1a0563857Add Solus install guide (#590)8a0d65b0dUpdate Windows Installation instructions (#564)c4348636aFix typo0a671bc37Add post to menu exampleaf14497c6Add notes for `os.Stat` (Hugo 0.47) (#557)e49f65bb3Singular to pluralcb5608dbfUpdate introduction.md30b060dffAdd variable re-definition example (Hugo v0.48+)21123967eMinor editsfac3df043Refresh the Go Templates introduction4a9600e92Updating URL to how-to-guide for hosting hugo site on firebasebfaa7779cadd missing wordc2cb5d09bTweak 'name: weight' to 'name: date' in example (#582)5ea938ad6Remove some Scratch2708dcd57Release 0.48e375d0f05Merge branch 'temp48'75e36c160releaser: Prepare repository for 0.49-DEVa6102f253releaser: Add release notes to /docs for release of 0.4841fc35db4releaser: Bump versions for release of 0.4864b9ecc74Spell out the npm command for installing PostCSS19e900a17Improved Related Content docfe21600e7Merge commit '844aef544c19e9d8f529b4f8144e089d0982bb34'844aef544Squashed 'themes/gohugoioTheme/' changes from 66249819..68ddff44069828db8Update git.mdd881d1433Make default "related" behavior more explicit60b9160ebAdd docs for displaying 404 page on CloudFrontb72ebc760Add .gitattributes to /resources000cf85f4Make the pros/cons styling consistent for summaries; use desc listebf1da97aAdd note about outputStyle compressede3338ee91Triple backquote syntax fix361962a7cAdd one more Blogger to Hugo tool for Windows (.NET Framework 4.5) (#540)066606a21Fix wrong link about Mmark Syntax Documentfaee70757Added exitwp-for-hugo6b4108051Add hugo-wrapper to starter-kits4695dfba2Added Utterances as Comments Alternatives.c7ba9e3e1Correct typobeb850d9fRelease 0.47.11cf417c8aMerge branch 'temp471'0843bc46creleaser: Prepare repository for 0.48-DEV8ff5c8b70releaser: Add release notes to /docs for release of 0.47.1e2353434dreleaser: Bump versions for release of 0.47.1ffb1300afUpdate development.mdc22234ea5netlify: Minify output5b9191c56Release 0.47bfd92cf52releaser: Prepare repository for 0.48-DEVac7acf730releaser: Add release notes to /docs for release of 0.47b0096099dreleaser: Bump versions for release of 0.4786a7ae459docs: Regenerate CLI docsd2c8b72bcMerge commit 'a95896878f4b4a79448b39ce93a4e0d3258b4a43'84de7ef59Merge commit '3a44bf182fed5f34621f450114083a6dd7e88a07' git-subtree-dir: docs git-subtree-split:6b00298bb2
Hugo Docs
Documentation site for Hugo, the very fast and flexible static site generator built with love in Go.
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
masterbranch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version. - The
nextbranch 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