mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
The world’s fastest framework for building websites.
3c0036805d
16753a78d remove kaiju from comments.md 25906f6ad Hugo 0.64.0 aacc7a130 releaser: Add release notes to /docs for release of 0.64.0 2243afe90 Explain Ace/Amber support has been removed 293c9496a Document the hugo function 479890f9b Update comments.md ceab41097 Update theme 9a95876c7 Remove note 696543e13 Update usage.md a04bab2b9 Release 0.63.2 ccaed74b5 Merge branch 'temp632' 623b363c5 releaser: Add release notes to /docs for release of 0.63.2 39ce6f50e releaser: Add release notes to /docs for release of 0.63.2 9175ac2ca Another theme fix 88c264251 Rebuild _vendor e739dc3a8 Release 0.63.1 129ecac84 Merge branch 'temp631' bcd7c1154 releaser: Add release notes to /docs for release of 0.63.1 e4f0d9285 releaser: Add release notes to /docs for release of 0.63.1 6a40124d6 Update theme c486747de Params cleanup c408c4334 netlify: Bump to 0.63.0 7e8a48be8 Adjust base template docs a5920e9aa Adjust release notes d4d25c524 Merge branch 'temp63' 16d981721 releaser: Add release notes to /docs for release of 0.63.0 08ab681d1 releaser: Add release notes to /docs for release of 0.63.0 90feaac39 docs, output: Add base template lookup variant to docs.json afe2b4399 docs, output: Add base template lookup variant to docs.json 1f7466a76 docs: Regen docs helper 7ceefb94a docs: Regen docs helper ee14087cd Remove typo from RenderString.md 6daf333d3 Remove the calibreapp action 682f710d7 docs: Updating 'submodule add' command in "Host on GitHub" to use https instead of ssh. ef57b2dae Improve documentation on slug behavior 835ddd9c2 Fix broken link 137a32f90 Fixed typo in content-management/page-resources 936633e25 Fixed spelling error, "wich" -> "which" a559d41e3 Using a Different Version of Hugo in AWS Amplify 2ee83402d Update rss.md f900a2ce0 Add render-image code example and edit wording bd0a0207c Change wording on Page Resources documentation d213b4599 linuxbrew was renamed to homebrew (#1004) dcb0925f8 Update index.md 789416a08 Release 0.62.2 2dc66f13c releaser: Add release notes to /docs for release of 0.62.2 813fbc865 releaser: Add release notes to /docs for release of 0.62.2 ed5b07df3 docs: Document the new autoHeadingIDType setting 02d4747e5 docs: Document the new autoHeadingIDType setting 406a8a9a6 docs: Regenerate docshelper 065319786 docs: Regenerate docshelper 61d540021 Merge commit '26f1458a2df6b55eee3a5de46f5fec23a43a7c7d' 7cac5909b releaser: Add release notes to /docs for release of 0.62.1 6e30e01a2 releaser: Add release notes to /docs for release of 0.62.0 2694dcdd8 Merge commit '8a4005cf2b0ef34265ff8051a6b76226685fc226' 115dd6782 docs: More on hooks f4460fd54 tpl: Do not return any value in errorf 3587d2998 tpl: Add a warnf template func 7c9b02e30 docs: Regen docshelper a7bfdeb24 Fix incorrect MIME type from image/jpg to image/jpeg 1a6089cfe Preserve HTML Text for link render hooks 4544a998c docs: Footnote c42733258 Add render template hooks for links and images 0d8bec78a Merge commit '2e711a28c71e8667258e5ab824f9b9a71c261b0a' 3974c326c markup/tableofcontents: Add config option for ordered list 8c2bd1a62 releaser: Add release notes to /docs for release of 0.61.0 f00b2d507 releaser: Add release notes to /docs for release of 0.60.1 9a5109838 releaser: Add release notes to /docs for release of 0.60.0 d2c222f71 Add Goldmark as the new default markdown handler df96f9efa Update homepage.md f17e67b4b tpl/collections: Allow dict to create nested structures 5f923768a Merge commit 'efc0b1bb6c6564f54d596467dbc6a18cb206954e' 8a861bf16 Support Go time format strings in permalinks bbb8c4fea releaser: Add release notes to /docs for release of 0.59.1 9d9070dda releaser: Add release notes to /docs for release of 0.59.0 98716176b Merge commit '5ac0f751aa47e52625662215f66efa99a6abfc2e' 2057ba4c5 Merge commit '5070ba6c9e6c492deade3c30cfe769b9dbf7151d' c98bcff07 Merge commit 'b9bd35d72e14932fb6588ff62b90cddef0a060fc' as 'docs' git-subtree-dir: docs git-subtree-split: 16753a78d85e05c4a2cea94e263dda2e0047d155 |
||
|---|---|---|
| .github | ||
| _vendor | ||
| archetypes | ||
| config | ||
| content | ||
| data | ||
| layouts | ||
| resources | ||
| src | ||
| static | ||
| .editorconfig | ||
| .gitignore | ||
| config.toml | ||
| go.mod | ||
| go.sum | ||
| LICENSE.md | ||
| netlify.toml | ||
| pull-theme.sh | ||
| README.md | ||
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