cb18a5183 Fix broken link 07a0198bf Config: Place Google Analytics tag ID under the services key 4bf0c719f Fix typo 50d8ad1af Fix muiltilingual menu definition instructions 1a32519a9 Fix typos 6f34ca8e0 Explain usage of front matter to target a template 5bd977257 Improve goldmark config docs 447632938 Remove Docker notes from installation instructions 84741d173 Update reference to hugo.work 0338d7c71 Fix menu template f5d2f5ed4 Fix typos in content/en/functions/fmt a3a40ff99 Add return type to functions 85ac3e779 Remove outdated feature image d47d889e4 Fix signatures 7551ba28f Document safe.JSStr function e77993be0 Document keyVals function 4dba20db3 Update theme babf91544 Update echoparam 8c8203efa Adjust related functions 4cb1b30fc Fix example ba95eca64 Improve showcase prose 5d3dcf366 Add Overmind Studios showcase 8d634ac70 Change code blocks from indented to fenced cfab978e6 Add missing code fences 407dd5c47 Limit related pages for functions to other functions 9fa67d981 Fix .Site.LastChange doc 393aa16d0 netlify: Hugo 0.119.0 f864af97a docs: Even more about images.Process 9d772d5f0 docs: More about images.Process bc655f869 docs: Regen docshelper 41c3536d1 Merge commit '9aec42c5452b3eb224888c50ba1c3f3b68a447e9' 918ed53f4 Add images.Process filter 573645883 Add $image.Process a1151b0fd Add images.Opacity filter git-subtree-dir: docs git-subtree-split: cb18a5183fc62f301ffde50b8c39f03e4b897aec
4.4 KiB
title | description | categories | keywords | menu | toc | weight | aliases | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Content formats | Both HTML and Markdown are supported content formats. |
|
|
|
true | 40 |
|
You can put any file type into your /content
directories, but Hugo uses the markup
front matter value if set or the file extension (see Markup identifiers
in the table below) to determine if the markup needs to be processed, e.g.:
- Markdown converted to HTML
- Shortcodes processed
- Layout applied
List of content formats
The current list of content formats in Hugo:
Name | Markup identifiers | Comment |
---|---|---|
Goldmark | md, markdown, goldmark | Note that you can set the default handler of md and markdown to something else, see Configure Markup. |
Emacs Org-Mode | org | See go-org. |
AsciiDoc | asciidocext, adoc, ad | Needs Asciidoctor installed. |
RST | rst | Needs RST installed. |
Pandoc | pandoc, pdc | Needs Pandoc installed. |
HTML | html, htm | To be treated as a content file, with layout, shortcodes etc., it must have front matter. If not, it will be copied as-is. |
The markup identifier
is fetched from either the markup
variable in front matter or from the file extension. For markup-related configuration, see Configure Markup.
External helpers
Some of the formats in the table above need external helpers installed on your PC. For example, for AsciiDoc files,
Hugo will try to call the asciidoctor
command. This means that you will have to install the associated
tool on your machine to be able to use these formats.
Hugo passes reasonable default arguments to these external helpers by default:
asciidoctor
:--no-header-footer -
rst2html
:--leave-comments --initial-header-level=2
pandoc
:--mathjax
{{% note %}} Because additional formats are external commands, generation performance will rely heavily on the performance of the external tool you are using. As this feature is still in its infancy, feedback is welcome. {{% /note %}}
Asciidoctor
The Asciidoctor community offers a wide set of tools for the AsciiDoc format that can be installed additionally to Hugo.
See the Asciidoctor docs for installation instructions. Make sure that also all
optional extensions like asciidoctor-diagram
or asciidoctor-html5s
are installed if required.
{{% note %}}
External asciidoctor
command requires Hugo rendering to disk to a specific destination directory. It is required to run Hugo with the command option --destination
.
{{% /note %}}
Some Asciidoctor parameters can be customized in Hugo. See details.
Learn markdown
Markdown syntax is simple enough to learn in a single sitting. The following are excellent resources to get you up and running: