To propose a change or addition, add it to the agenda for an upcoming SIG Docs meeting, and attend the meeting to participate in the discussion. Note: Kubernetes documentation uses Goldmark Markdown Renderer with some adjustments along with a few Hugo Shortcodes to support glossary entries, tabs, and representing feature state. Goldmark (Hugo v0.60+) Since Hugo v0.60.0, the default Markdown-parser has switched to the CommonMark -compliant Goldmark. The previously default Markdown-parser Blackfriday is not compliant with any spec, and has many bugs (for which ox-hugo needs to keep adding workarounds). See these Hugo v0.60.0 release notes to learn more.
- We recommend this 'markdown' mode to advanced users who have a high comfort level with Hugo, and want to use the full power of Goldmark (and understand the trade-offs of not using Pandoc for rendering here, e.g., not all Pandoc’s Markdown features are supported by Goldmark).
- Hugo uses the Goldmark Markdown processor, which is fully compatible with the CommonMark specification, so the application Markdown support is excellent. The processor used by Hugo, Goldmark, has a file called config.toml that allows you to configure the tool. Here is an example of the configuration file.
- Note: Kubernetes documentation uses Goldmark Markdown Renderer with some adjustments along with a few Hugo Shortcodes to support glossary entries, tabs, and representing feature state. Language Kubernetes documentation has been translated into multiple languages (see Localization READMEs ).
Overview
Hugo is a powerful tool that offers incredible speed to build website.
To have an idea of its power, Hugo can process a website with thousands of pages in seconds.
Companies like Smashing Magazine switched from the highly acclaimed WordPress to Hugo, given its ability to generate websites.
Hugo uses the Goldmark Markdown processor, which is fully compatible with the CommonMark specification, so the application Markdown support is excellent.
The processor used by Hugo, Goldmark, has a file called config.toml
that allows you to configure the tool.
Here is an example of the configuration file:
Goldmark Markdown Schedule
You can visit the Hugo official website by clicking here.
See also the setup instructions and see which extensions are configurable in Goldmark.
Hugo Markdown Goldmark
Hugo Markdown Support
In Table 1.1 you have a list of Markdown elements compatible with Hugo.
Element | Support | Information |
---|---|---|
Titles | Yes | |
Paragraphs | Yes | |
Line breaks | Yes | |
Bold | Yes | |
Italic | Yes | |
Blockquote | Yes | |
Ordered lists | Yes | |
Unordered lists | Yes | |
Code | Yes | |
Horizontal lines | Yes | |
Links | Yes | |
Images | Yes | |
Tables | Yes | |
Fenced code blocks | Yes | Hugo allows you to highlight the syntax of the code block content based on the programming language. |
Footnotes | Yes | |
Title Id | Yes | |
Definition lists | Yes | |
Strikethrough | Yes | |
Task lists | Yes | |
Emoji (copy and paste) | Unknown | |
Emoji (access codes) | Yes | |
automatic URL Link | Yes | |
Disable automatic link from URL | Yes | |
HTML | Yes |