Please read the following guidelines before requesting help in the forum.
How to Request Help
Welcome to the Hugo forums and thanks for using Hugo! A few friendly tips on getting help in this forum.
- Search the forum , because it is likely that your question has been asked and answered already. Do your homework.
- Read the docs, because they are good and a lot of work goes into them. Then read them again.
- Note to address repeat inquiries about common problems:
- If your posts are not showing up, check if draft is set to true in your frontmatter.
- Create a new thread in #support, for each new issue. Generally speaking, let us know:
- what you were doing or what you tried,
- what you expected, and
- what actually happened.
- Include a link to the source code repository of your project, because we really need the context of seeing your templates and partials to be able to help you.
- If you can’t share your repository for whatever reason, consider creating a dummy repo that you can share, which reproduces the problem you’re experiencing.
- Consider getting a free Github account and using Github “gists” for pasting logs and files (or another pastebin web app), which you can use even if you do not yet understand
git, or have a source code repository. You can include multiple files in a single gist.
- Include a link to the theme you’re using. Consider contacting the theme’s author, if it is a theme-specific question because often the author will know better than the random passer-by in the forum. Check the theme’s README.
- Format your posts using markdown, BBCode or HTML. See Sharing code in the forums for some good tips on code formatting.
- Use the
hugo serverto produce more details on the command line including about errors.
- Include the output of
hugo envfrom the command line, or any other relevant versions.
- Mark the best answer in the thread using the checkbox icon from the comment action menu (with like, edit, bookmark etc). This marks the thread as solved.
- Close the loop, by posting a summary in your thread about how you were able to solve the problem. In fact, keeping communications public, clear and complete helps the project.
~> hugo env Hugo Static Site Generator v0.47/extended darwin/amd64 BuildDate: 2018-08-17T09:27:19Z GOOS="darwin" GOARCH="amd64" GOVERSION="go1.10.3" ~> git version git version 2.18.0
Some Knowledge Required
Let me mention here that you do need some basic knowledge of html, css, command line and editors to use Hugo effectively, as it builds on top of that knowledge. There are too many sites to mention but if you’re just starting, here are a couple of sites to take a look at: w3schools, HTML5 Boilerplate or hackr.io. Take a look at the Recommended Reading wiki post in the forum, as well.
Simple Code of Conduct
Finally, this is a positive and friendly community, and as with other open source projects, the Hugo project runs on unpaid volunteer work. Please be reminded of a couple of rules to make things easier in the forum:
- Offer what help you can, as there is never enough time to do everything.
- Assume good intentions. English is the language of the forum, but, it is not every user’s native language.
- Keep it civil, courteous and polite. No personal or ad hominem attacks.
- Discussion should be on topic, related to
We haven’t had to do it very often, but, we reserve the right to ban or suspend from this community anyone who cannot play by the rules. Thanks for your understanding and cooperation.