Hugo

Requesting Help

DOCS | THEMES | NEWS | GITHUB | FAQ | RELEASE NOTES

Please read and follow the below guidelines before asking for help in the forum.

How to Request Help

Welcome to the Hugo forums and thanks for using Hugo! The below are a few friendly tips on getting help from the other Hugo volunteers in this forum.

Some Knowledge Required

Dare we say that while Hugo is indeed pretty magical, it is not meant to be a “magic wand” to suddenly give you a published website a la Square Space or Wordpress.com. You are expected to already know how to assemble a static web page, for which you do need some basic knowledge of html, css, command line and text editors. Or how to prepare a space to host your website. The bottom line is, if you are unwilling to invest the time required to learn these things, then Hugo is not for you.

If you do put the time in, Hugo will help you rapidly merge your html templates, css, javascript, media, and even data, into a flexible working site. In addition, you get the added benefit of understanding how things fit together, which in turn makes understanding a variety of website builders and content management systems much easier. It is really a worthwhile investment to put the time in, to learn the basic building blocks well.

There are too many such sites to mention but if you’re just starting out, 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.

Ok, got it, how do I get help?

Thanks for bearing with me on the above, which needed to be said given the sheer volume of people asking similar questions. Here are several points that if you follow, will help get you a positive outcome in the forums:

Search First

Search the forum :mag:, because it is likely that your question has been asked and answered already. Do your homework.

Read the Docs

Read the docs, because they are pretty good and a lot of work goes into them. Then read them again. But note that they sometimes lag behind releases a bit. If you can help with that, please do.

A corollary to this is, read the release notes. If you are having a problem after upgrading Hugo, you may find a hint here.

Frequently Asked Questions

Notes to address repeat inquiries about common problems:

  • If your posts are not showing up, check if draft is set to true in your content frontmatter.
  • Run hugo server for the development server for inspecting your site during development, and just hugo to generate the /public folder in your project, which you upload to your site container.
  • In your config, make sure baseURL is correct.
  • If you are using a theme, you can override the theme’s files to make a change. For instance, assuming you are using Hyde, installed at /themes/hyde in your project, you can copy /themes/hyde/layouts/index.html to /layouts/index.html and edit that. Your copy will override that of the theme.
  • Hugo’s lookup order is a source of confusion at first, but it is well defined and will help you understand what template is being applied to a given page.
  • Hugo commands are case-sensitive, so pay attention to that when you build your templates.

General thread mechanics

Create a new thread in #support, for each new issue. Generally speaking, let us know:

  1. what you were doing or what you tried,
  2. what you expected, and
  3. what actually happened.

Format your forum posts using the de facto standard markdown, BBCode or HTML. See Sharing code in the forums for some good tips on code formatting.

When you do get an answer, 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.

Finally, please 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.

Let us see your code

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. It is trivial to do a quick git clone on your repo, then run hugo server in your project, to help you out. On the other hand, recreating your code from screenshots, or sort of guessing at it, is not.

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.

Git repository hosting services include Github, Bitbucket, Codebase, Gitlab, Sourcehut, and others. If you select Github, even if you do not know git or have a repository, you can use Github “gists” for pasting logs and files. You can include multiple files in a single gist, like this one.

Are you using a theme?

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. But at least include a link to the theme, to help a person trying to help you.

Include Output and Environment Details

First, use the --verbose switch on hugo server to produce more details on the command line including about errors.

Include the output of hugo env from the command line, and any other relevant versions.

~> hugo env
Hugo Static Site Generator v0.55.2-9D0203488/extended darwin/amd64 BuildDate: 2019-04-17T12:29:48Z
GOOS="darwin"
GOARCH="amd64"
GOVERSION="go1.12.2"
~> git version
git version 2.20.1

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:

  • Pitch in!, and offer what help you can, as there is never enough time to do everything. If you noticed that something is lacking in the docs, you’re probably right, so please contribute!
  • Assume good intentions. English is the language of the forum except for a couple subforums, but, it is not every user’s native language. Try to avoid too much slang, abbreviations, or idiomatic expressions.
  • Keep it civil, courteous and polite. No personal or ad hominem attacks.
  • Don’t waste people’s time.
  • Discussion should be on topic, related to hugo usage. No OT topics like general JavaScript or CSS, or politics, please.
  • Consider this forum as the official support forum, not Stack Overflow or Reddit.

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.

9 Likes
Problems with my first site
As Beginner, should I create .Md or .HTML pages
About template lookup order and creating sections and lists
Cannot access Hugo website
/content/ Directory Not being display, only 404 error page
No static files after Hugo Update from 0.41 to 0.42.1
Content directories getting into site map
How does defaultContentLanguageInSubDir work?
Using range where with front-matter values
Hugo serve error
Documentation for template syntax, structure, and variables
Multiple single site based on one content file with conditional parts
Help me with something in Hugo
Trouble with intersect and json data
Possible Bug: Hugo complains about duplicate menu entries in 0.55.5
Hugo output error
Hugo 101: Processing Images
Resize image from static folder
.Site.Data is just empty map[]
Increase page width to display table
Function “Hugo” not defined
Vertical sections not displaying
How to keep inner text unchanged in markdown?
Og:site_name is not generated using template "_internal/opengraph.html"
Pages with _index.md not updating
Taxonomy list is alwasy empty
[Solved] Do that unless there is content in the page
[Solved] Do that unless there is content in the page
Keeping drafts out of the rss feed
Hugo frontmatter aliases do not get created for custom content types
Can I split a .Site.Menu range over multiple columns?
List all tags, categories
Image Processing syntax
Default language in both root and subfolders
Problems with Hugo and Prism.js
How to render a set of HTML files directly?
Prepare for multilingual site by placing all content in lang-folder?
Content folder automatic creates menu
Reveal-hugo Theme rendering blank page
Publishing Hugo
Clean way to override capitilization of Site.Title (and subtile)
Custom Robots.txt and sitemap.xml Templates
Include-file shortcode context issues
Pagination fails after listing posts
How to link tags list to post list
Use minimo's [recent_posts] widget in the menu
JPG error after upgrading Hugo
Posts not being listed with custom directory
Add Matlab icon to Skill section
Theme Appearance different from local to internet
Help with Customizing beautifulhugo theme
Help with Customizing beautifulhugo theme
Public folder - clarification needed
Some beginner questions about themes
No sidebar background in deployed Netlify production website
Home page showing full path
Dynamically load datafiles based on variables
Search Index .json-file for Lunr.js
Problems with my first site
[SOLVED] Baseof.html rewrite doesn't work as expected
Access term metadata from within .Data.Terms.ByCount loop
Adding a logo to Hyde theme
How to get hugo to serve an HTML page from /static/
Static pdf files always return 404
Hugo doesn't produce output
Cannot match the specified template
How to Emulate Linked List Behavior
How to sort on inner field?
"hugo server" serves content pages, but "hugo" (build) doesn't build them
How to implement a scrolling list in hugo academic theme for a custom widget
Hugo href links not working - 404 error
Referencing an image path from a page bundle in SCSS
Youtube shortcode from data file?
Error 404 images
Blog content not showing on my blog page
Pages and navigation build inconsistently
CSS won't render on on watch
Add raw html page as post
Loop Problem
.Params not working in home.md?
Regarding Multiple inner pages with differnent-2 Layout
Add link to title from scratch output
Get First Page of Home
Just a new by in need
Theme mainroad: how to hide posts in the main page?
Multilingual permalinks with relLangURL and custom slug
Merge local and data-driven content in list
Using .range in a single page and .md files
The Icon image lost on the Gitlab Pages
Link clickable
Error compiling Swiper CSS
Mermaid shortcode not working
Taxonomy terms do not render when sorted by weight
Adding news section with limited number of posts and without extra pages
Iterate through an array of nested maps(json objects)
Translation of the plural and zero in Russian returns the name of the variable
Control which pages get generated
Some of my tags doesn't work
Get URL formatted URL string
Display size of forum guidelines
Can't figure out the very basics of content structure ↔︎ generated
How to access home page params from any context
Add image url
Where to add the function latest posts?
Function "resources" not defined
Hugo not rendering title / date anymore
Regarding Logo path not working
Change theme in Hugo
RSS Feeds for diffrent file types
[SOLVED] About page not being generated for GitHub Pages
Created a new theme but theme cannot be found Gitlab Hosting
Images in static folder only display locally
Why generated paged's link without suffix html?
[SOLVED] Relative link to markdown file from config.toml
Escaping Meta Tag Content? Help
[SOLVED] Site only displaying submodule content
Sorting paginated pages by date
Link to IRC in menu doesn't work
Adding Pages in the Kube Theme
[SOLVED] How to setup permalinks for all pages?
[SOLVED] Not able to install theme/set it in config
[SOLVED] Tag list pages work locally but are 404 in production
Hugo gives 404 instead of static page
Sidebar on sub pages
Embedded Getty images in Hugo
Embedding dj3s in posts
How to override index.md
Handling of unknown file extensions?
How to translate only a subset of the pages?
Cannot get mmark include to find the file. What am I doing?
Not able to access files from unknown folder
Rendering lastmod date
How to replace the main image in Hugo AirSpace Theme
Custom Robots.txt and sitemap.xml Templates
Social Media icons from Codepen
`hugo --minify` strips out `</p>` tags
[SOLVED] Problem on shared hosting
Pagination creates both /pages/ and /section/page/
Filtered Pagination results in a "gap"
Converting blog to AMP gives blank page
Repeated section hidden in html
Hugo 0.47 --minify fails with "parse error:3:5: unexpected ending in qualified rule, expected left brace token 3:<"
Wercker S3 pipeline :error while building
Disabling a hugo help site
How to create dropdown menu in sidebar
Post link leads nowhere and images not showing up on site
How to create dropdown menu in sidebar
Hugo site locally has no index.html in public folder yet works on Netlify
[SOLVED] Exclude a post type from rendering, but not from the list?
relURL not always outputing URL
[SOLVED] Theme not rendering on site
How to add page content (custom theme)
Range breaking main page
[SOLVED] New Theme Not Rendering
Manually changing date in page front matter stops page from being rendered
Hugo themem create home page and seperatly a route to display blog post
Anchor for headlines
Issue when deploying with Gitlab
[Quickstart] Content not displayed when site deployed
[SOLVED] Json data generated from PowerShell could not be read from Hugo
Bundled images, range, and context
CSS Styles Not Working on Posts and Some Navigation Links
Rendering page resources
Can page resources be put into a custom order?
Changing a hugo theme and PDF output
Some strange issue
Tag "C#" page show 404
Need help with categories and tags pages
Scary letters in Windows cmd
[SOLVED] Header and Footer of a Blog Post are not Rendered Correctly after Translation (mulilingual mode)
Affiliation url link in academic template is not working
[SOLVED] Functions in shortcodes not available?
Making static pages render
Error while trying to build cloned site
Importing trees of md files into a Hugo project?
<delimit .Params.tags...>: error calling delimit:
Link to index.md -> index.html
error error
I need help
Canned replies plugin
[SOLVED] Reference multilingual content from template
Generate proper URLs from an array of srcset in front matter
Create pagination for specific tag inside array of tags
Problems using Algolia with Hugo: javascript and go
Developing Locally, Problem with Paths
Use different layout for a specific Term in a Taxonomy
String / Variable Concatenation to build Path for partial
Using `absURL` in a SVG `<use>` element
How to change blog posts order to ascending (chronological) order
Count of posts in category taxonomy terms list
Is there a way to use larger numbers than a normal int
Problems with safeHTML
How can I redirect to an external link on click of header of any blog?
Split a post/page up into different web pages with pagination
Publications not shown
Linking to external javascript file
Hugo ignores existing content. shortlink error: No page found with path or logical name
Hugo-git v0.34.r27.g4eb2fec6-1 broke will see if v0.31.1 will handle it now
[Solved] Select files that are direct children of content, not in sub-folders
Google Search Console reports sitemap.xml as invalid
Md content markup converted to html markup
How can I make images viewable on local hugo server?
Unable to generate cloned hugo Website
Is it possible to loop through shortcode arguments?
Github Site not rendering in Hugo Theme
Is it Possible to create a website with multiple themes
BlogDown Academic
Append to Aside
Having trouble fixing tab title text
[SOLVED] Menu ordering not working
Need better debugging support
(solved) Problem listing languages in a correct order and switching to a language-specific page URL
Images on Project view=1
Weird URL duplication problem
Gitlab Pages and Static Files
Help with error when setting up deployment pipeline - Travis-ci
Is there any flag for offline rendering?
How can I put my taxonomy items into a fixed order?
Selecting a menu item when displaying a list of items based on taxonomy
[SOLVED] Struggling to use .Resources in a leaf bundle
[SOLVED] Lastmod vs Docker Container
Problems with extra single.html for leaf bundle
Issue Updating Title or Sub-title on Hugo
`hugo serve --bind` doesn't work with multilingual?
How to iterate over headless pages?
preserveTaxonomyNames being sporadic?
Syntax higlighting works only locally
Unclear how to use lang.Merge - How to add language fallback for content
Incomplete generation of a new theme
Creating RSS feed for a section [SOLVED]
Site doesn't load as expected on Firebase
How to display recent posts in the homepage?
Custom list.html for categories page
Avatar not showing
How to subtract 2 variable?
Cactus Plus Twittercard Issue
Ordering & limiting elements in menu
Using .Inner shortcode to add style
Questions when running the Hugo in a Docker container
Can I prevent markdownify to introduce 'id' for headers?
Meta tags not displaying
Vim syntax highlighting for Hugo HTML templates
Multipage Content Types?
Is it possible to get every category dynamically to display it?
Using Html instead of Markdown
Please help me add an external link to my site
List Template with Top-Level Sub-Directories listed with pages
Please help me add an external link to my site
Issue with viewing /posts on Hugo site, GitHub pages
Stylesheed doesn't render in gitlab pages
Multiple blogs in a single domain
Cannot get jQuery to work in Hugo
Adding Twitter Feed - Solved
Attaching Expired Authors to Posts?
Upgrading problems
[SOLVEDAfter 'hugo server' I get 404 unless I re-save a file]
Installed hugo. Installed template. But localhost:1313 BLANK or ERROR
How can I switch the language of the current page
Best theme for Hugo beginner
Create a new page with custom layout
Config.filetype Code Toggle won't work
How to change theme for Hugo website hosted on Gitlab

Reformatted the other day for readability, and added links to release notes today.

1 Like