mirror of
https://github.com/tiennm99/hugoDocs.git
synced 2026-10-13 22:16:02 +00:00
Bjørn Erik Pedersen
3c0036805d
16753a78dremove kaiju from comments.md25906f6adHugo 0.64.0aacc7a130releaser: Add release notes to /docs for release of 0.64.02243afe90Explain Ace/Amber support has been removed293c9496aDocument the hugo function479890f9bUpdate comments.mdceab41097Update theme9a95876c7Remove note696543e13Update usage.mda04bab2b9Release 0.63.2ccaed74b5Merge branch 'temp632'623b363c5releaser: Add release notes to /docs for release of 0.63.239ce6f50ereleaser: Add release notes to /docs for release of 0.63.29175ac2caAnother theme fix88c264251Rebuild _vendore739dc3a8Release 0.63.1129ecac84Merge branch 'temp631'bcd7c1154releaser: Add release notes to /docs for release of 0.63.1e4f0d9285releaser: Add release notes to /docs for release of 0.63.16a40124d6Update themec486747deParams cleanupc408c4334netlify: Bump to 0.63.07e8a48be8Adjust base template docsa5920e9aaAdjust release notesd4d25c524Merge branch 'temp63'16d981721releaser: Add release notes to /docs for release of 0.63.008ab681d1releaser: Add release notes to /docs for release of 0.63.090feaac39docs, output: Add base template lookup variant to docs.jsonafe2b4399docs, output: Add base template lookup variant to docs.json1f7466a76docs: Regen docs helper7ceefb94adocs: Regen docs helperee14087cdRemove typo from RenderString.md6daf333d3Remove the calibreapp action682f710d7docs: Updating 'submodule add' command in "Host on GitHub" to use https instead of ssh.ef57b2daeImprove documentation on slug behavior835ddd9c2Fix broken link137a32f90Fixed typo in content-management/page-resources936633e25Fixed spelling error, "wich" -> "which"a559d41e3Using a Different Version of Hugo in AWS Amplify2ee83402dUpdate rss.mdf900a2ce0Add render-image code example and edit wordingbd0a0207cChange wording on Page Resources documentationd213b4599linuxbrew was renamed to homebrew (#1004)dcb0925f8Update index.md789416a08Release 0.62.22dc66f13creleaser: Add release notes to /docs for release of 0.62.2813fbc865releaser: Add release notes to /docs for release of 0.62.2ed5b07df3docs: Document the new autoHeadingIDType setting02d4747e5docs: Document the new autoHeadingIDType setting406a8a9a6docs: Regenerate docshelper065319786docs: Regenerate docshelper61d540021Merge commit '26f1458a2df6b55eee3a5de46f5fec23a43a7c7d'7cac5909breleaser: Add release notes to /docs for release of 0.62.16e30e01a2releaser: Add release notes to /docs for release of 0.62.02694dcdd8Merge commit '8a4005cf2b0ef34265ff8051a6b76226685fc226'115dd6782docs: More on hooksf4460fd54tpl: Do not return any value in errorf3587d2998tpl: Add a warnf template func7c9b02e30docs: Regen docshelpera7bfdeb24Fix incorrect MIME type from image/jpg to image/jpeg1a6089cfePreserve HTML Text for link render hooks4544a998cdocs: Footnotec42733258Add render template hooks for links and images0d8bec78aMerge commit '2e711a28c71e8667258e5ab824f9b9a71c261b0a'3974c326cmarkup/tableofcontents: Add config option for ordered list8c2bd1a62releaser: Add release notes to /docs for release of 0.61.0f00b2d507releaser: Add release notes to /docs for release of 0.60.19a5109838releaser: Add release notes to /docs for release of 0.60.0d2c222f71Add Goldmark as the new default markdown handlerdf96f9efaUpdate homepage.mdf17e67b4btpl/collections: Allow dict to create nested structures5f923768aMerge commit 'efc0b1bb6c6564f54d596467dbc6a18cb206954e'8a861bf16Support Go time format strings in permalinksbbb8c4feareleaser: Add release notes to /docs for release of 0.59.19d9070ddareleaser: Add release notes to /docs for release of 0.59.098716176bMerge commit '5ac0f751aa47e52625662215f66efa99a6abfc2e'2057ba4c5Merge commit '5070ba6c9e6c492deade3c30cfe769b9dbf7151d'c98bcff07Merge commit 'b9bd35d72e14932fb6588ff62b90cddef0a060fc' as 'docs' git-subtree-dir: docs git-subtree-split:16753a78d8
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