mirror of
https://github.com/gohugoio/hugo.git
synced 2026-09-02 19:52:38 +00:00
Bjørn Erik Pedersen
07b8d9466d
fb551cc75Update index.md7af894857Update index.mdd235753eaHugo 0.82.1e03e72debMerge branch 'temp0821'e62648961Merge branch 'release-0.82.1'e1ab0f6ebreleaser: Add release notes to /docs for release of 0.82.15d354c38dReplaced ``` code blocks with Code Togglerc9d065c20Remove duplicate YAML keys (#1420)8ae31e701Add webp image encoding support848f2af26Update internal.md (#1407)c103a86a4Fix `ref` shortcode example output (#1409)9f8ba56dcRemove leading dot from where function KEY (#1419)363251a51Improve presentation of template lookup order (#1382)b73da986dImprove description of Page Resources (#1381)4e0bb96d5Rework robots.txt page (#1405)edf893e6fUpdate migrations.md (#1412)450f1580bAdd link to `site` function doc (#1417)cfffa6e6fAdded one extension to the list (#1414)05f1665a0Update theme5de0b1c6aUpdate theme250e20552Add hugo.IsExtendeddea5e1fd7Fix typo on merge function page (#1408)1bbed2cf3Update configuration.mdbe0b64a46Omit ISOcbb5b8367Fix `dateFormat` documentation698f15466Regenerate the docshelperf9a8a7cb6Update multilingual.mda22dc6267Fix grammar (#1398)eb98b0997Fix pretty URL example (#1397)f4c4153dcMention date var complementation in post scheduling (#1396)17fae284cFix resources.ExecuteAsTemplate argument order (#1394)97e2c2abbUse code-toggle shortcode in `multilingual.md` (#1388)3a84929bbHarmonize capitalization (#1393)17f15daa6fix file naming used in example (#1392)5d97b6a18Add slice syntax to sections permalinks config00665b97bImprove description of `site.md`edcf5e3fcFix example in `merge.md`f275ab778Update postprocess.md9593e3991Fix file name59bd9656fUpdate postprocess.md1172fb6d0Update to theNewDynamic repository (#1263)f5b5c1d2cUpdate Hugo container image4f2e92f2aAdapt anchorize.md to Goldmark98aa19073Directly link to `highlight` shortcode (#1384)4c75c2422Fix header levelf15c06f23markdownify: add note about render-hooks and .RenderString (#1281)69c82eb68Remove Blackfriday reference from shortcode desc (#1380)36de478dfUpdate description of ignoreFiles config setting (#1377)6337699d8Remove "Authors" page from documentation (#1371)35e73ca90fix indent in example (#1372)d3f01f19aRemove opening body tag from header example (#1376)341a5a7d8Update index.mdc9bfdbee6Release 0.82.0119644949releaser: Add release notes to /docs for release of 0.82.032efaed78docs: Regenerate docs helperdea5449a2docs: Regen CLI docseeab18fceMerge commit '81689af79901f0cdaff765cda6322dd4a9a7ccb3'd508a1259Attributes for code fences should be placed after the lang indicator onlyc80905cefdeps: Update to esbuild v0.9.095350eb79Add support for Google Analytics v402d36f9bcAllow markdown attribute lists to be used in title render hooks7df220a64Merge commit '9d31f650da964a52f05fc27b7fb99cf3e09778cf'd80bf61b7Fixes #7698. git-subtree-dir: docs git-subtree-split:fb551cc750
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 the following criteria 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 example, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great. 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 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 are 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