mirror of
https://github.com/tiennm99/hugoDocs.git
synced 2026-10-13 20:14:58 +00:00
Bjørn Erik Pedersen
eb16165694
d1cf9adc4Fix typo26e10a690Fix the name and arg mismatch between partial defn and call2db0e53cdMerge commit '9c36cff15224f6cbd19058ad61311229b7a23c83'9c36cff15Squashed 'themes/gohugoioTheme/' changes from 68ddff44..b8202f534b021eff8Update lang.Merge.mdb37af2916Add title to yamla9a281233Fixed incorrect usage of the code-toggle shortcode4560a0169Update Warning for Theme Links (#676)0305e3c6bDocument .File.ContentBaseName6d30c5aa1Update configuration.md158df174aDocument .Sites and .Sites.First0c0f583b8Add stale confige2531afd8Document path template functions4dd779057Clarify that partialCached is per site/language19e5bbe0cUpdate index.md44b000857Add missing dota41300cf9Release 0.522d1d92b88Merge branch 'temp52'c5925250dreleaser: Prepare repository for 0.53-DEVd000b04a2releaser: Add release notes to /docs for release of 0.524bb983a0areleaser: Bump versions for release of 0.5236736ca28tpl: Add "param" shortcode378677aa6Add Elasticsearch/bonsai.io to services doc.4c3fd4fa4docs: Document inline shortcodes6c64c374cWhitelist CSS modules from purge817a872b9Improve search icon positioncf86ff1c7Add minification and resource cache clear to build commandfd77e8df3Update asset dependencies and adopt Hugo Pipescdbe97e8cUpdate render.mdb0e279220git command to update submodule to latesta1cb98c12cache/filecache: Add a :project placeholder07c1b2b46cache/filecache: Use time.Duration for maxAgeffa9b165eAdd AND as a title6e7733b40Add OR as a sub title to make it easier to find in search72b6791a1docs: Document the new file cache714d3ca91Fix minification issuescd1e961daRevert "Add Elasticsearch/bonsai.io to services doc."15a0cda6eAdd Elasticsearch/bonsai.io to services doc.f931d86deRelease 0.51e2ffe867aMerge branch 'temp51'423e7f5c8releaser: Prepare repository for 0.52-DEVc6f2d6ae1releaser: Add release notes to /docs for release of 0.515bbb556dcreleaser: Bump versions for release of 0.513b2b172b9docs: Document shortcode error handlingb8672f3d4docs: Document symdiff4bc6071e6docs: Document complementd1baab752docs: Re-generate CLI docs9ea667e24Revert "tpl: Update Jsonify to return pretty-print output"ce5a1403ddocs: Regenerate the docs helper99a1f4a94Fix note for reserved partial name(starting with -> including).eba3cbc42fix accidentally modification on paragraph.3eebd98c3Add note for reserved partial name.40b881cc2Document templates.Existsb5c3bcd3bUpdate multilingual.md61c59c67eFix misspelling (#648)f21d8c4a4Correct minor typo (#5372)e967001b9Release 0.50685fd6b08releaser: Prepare repository for 0.51-DEVf245a9faareleaser: Add release notes to /docs for release of 0.504354da30dreleaser: Bump versions for release of 0.50feaa05469docs: Regenerate CLI docs5c724200cMerge commit 'd6a4af7018e8618944a6471ceeb7aae1d4df6afa'2ddab36c2Merge commit '74309fe5699a595080fdb3a14711e0869babce99'8cf296a7cdocs: Regenerate CLI docs9097683ddtpl: Update Jsonify to return pretty-print output git-subtree-dir: docs git-subtree-split:d1cf9adc41
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