hugo-wasm/content/en/content-management/formats.md
Bjørn Erik Pedersen 346b60358d Squashed 'docs/' changes from 4429eeeea..73a01565c
73a01565c Remove comment shortcode documentation
0ca7ccd30 Replace usage of comment shortcode with HTML comments
fe10d9899 Remove expired new-in labels
11e89dfcb [editorial] Link to proper render-hook page in relref.md
11a581c2f netlify: Hugo 0.142.0
1a4fcf7f7 Miscellaneous edits
2c7a3165f Markdown linting and cleanup
69d7a781b Replace links to glossary terms with custom render hook syntax
441752d2d Refactor glossary lookup portion of link render hook
80109a14f Fix glossary term linking for plural form
cd95f0f34 Update link render hook to support glossary links
53eadb430 Remove the glossary template
1d40a7f3b Improve transform.ToMath examples
586970df2 Misc edits
6a06a8de7 Add glossary link shortcode
4171c0eb7 Improve description of masking with non-transparent images
41c8feb64 Fix example of image.Mask filter
704a81656 Add alignx option to images.Text usage example
7c03eb0cc Clarify context in example of using the try statement
56d9c9b71 Refactor glossary of terms
042a6846b Add expiry dates to deprecated methods pages
365ab345f Remove services key from instagram shortcode page
b7fe31e07 Reorder options list for images.Text filter
8051ff818 Format directory names, file names, and file paths as code
d09a14623 Update version refs for Hugo and Dart Sass
3bb006974 Add NODE_VERSION to Netlify config examples
3a0f2531e Fix typo
7e3198eaf Fix typo
cf56452a3 Fix typo
a9f51d13e Fix typo
82bfdd8c3 Fix typo
a5c41a053 Fix typo
abcfed7a5 Fix typo
8c1debf3a Remove outdated new-in badges
809ddf9ef Update theme
63867d56f Use warnf instead of errorf in try-catch example
dee3e5f09 Update theme
9791f7057 Remove TODO from comment shortcode examples
a346ca1fd Elevate embedded shortcode documentation to its own section
8fa19b50f hugoreleaser.toml =>  hugoreleaser.yaml
575d60345 Update docs for v0.141.0
a0a442d62 netlify: Hugo 0.141.0
6667cbcd8 Merge commit '81a7b6390036138356773c87a886679c81c524e1'
f36fc013e docs: Regen CLI docs
365a47ded tpl/images: Change signature of images.QR to images.QR TEXT OPTIONS
ae8f8af0a images.Text: Add "alignx" option for horizontal alignment
8f45ccca6 docs: Regen CLI docs
f0e6304f4 Merge commit 'e9fbadacc3f09191e2e19f112a49777eeb8df06c'
cb9bec2b2 tpl/images: Add images.QR function

git-subtree-dir: docs
git-subtree-split: 73a01565c5ba0774d65aa6f2384c44804fefa37d
2025-01-23 09:46:02 +01:00

5.4 KiB

title description categories keywords menu weight toc aliases
Content formats Create your content using Markdown, HTML, Emacs Org Mode, AsciiDoc, Pandoc, or reStructuredText.
content management
markdown
asciidoc
pandoc
content format
docs
parent weight
content-management 40
40 true
/content/markdown-extras/
/content/supported-formats/
/doc/supported-formats/

Introduction

You may mix content formats throughout your site. For example:

content/
└── posts/
    ├── post-1.md
    ├── post-2.adoc
    ├── post-3.org
    ├── post-4.pandoc
    ├── post-5.rst
    └── post-6.html

Regardless of content format, all content must have front matter, preferably including both title and date.

Hugo selects the content renderer based on the markup identifier in front matter, falling back to the file extension. See the classification table below for a list of markup identifiers and recognized file extensions.

Formats

Markdown

Create your content in Markdown preceded by front matter.

Markdown is Hugo's default content format. Hugo natively renders Markdown to HTML using Goldmark. Goldmark is fast and conforms to the CommonMark and GitHub Flavored Markdown specifications. You can configure Goldmark in your site configuration.

Hugo provides custom Markdown features including:

Attributes
Apply HTML attributes such as class and id to Markdown images and block elements including blockquotes, fenced code blocks, headings, horizontal rules, lists, paragraphs, and tables.
Extensions
Leverage the embedded Markdown extensions to create tables, definition lists, footnotes, task lists, inserted text, mark text, subscripts, superscripts, and more.
Mathematics
Include mathematical equations and expressions in Markdown using LaTeX markup.
Render hooks
Override the conversion of Markdown to HTML when rendering fenced code blocks, headings, images, and links. For example, render every standalone image as an HTML figure element.

HTML

Create your content in HTML preceded by front matter. The content is typically what you would place within an HTML document's body or main element.

Emacs Org Mode

Create your content in the Emacs Org Mode format preceded by front matter. You can use Org Mode keywords for front matter. See details.

AsciiDoc

Create your content in the AsciiDoc format preceded by front matter. Hugo renders AsciiDoc content to HTML using the Asciidoctor executable. You must install Asciidoctor and its dependencies (Ruby) to use the AsciiDoc content format.

You can configure the AsciiDoc renderer in your site configuration.

In its default configuration, Hugo passes these CLI flags when calling the Asciidoctor executable:

--no-header-footer

The CLI flags passed to the Asciidoctor executable depend on configuration. You may inspect the flags when building your site:

hugo --logLevel info

Pandoc

Create your content in the Pandoc format preceded by front matter. Hugo renders Pandoc content to HTML using the Pandoc executable. You must install Pandoc to use the Pandoc content format.

Hugo passes these CLI flags when calling the Pandoc executable:

--mathjax

reStructuredText

Create your content in the reStructuredText format preceded by front matter. Hugo renders reStructuredText content to HTML using Docutils, specifically rst2html. You must install Docutils and its dependencies (Python) to use the reStructuredText content format.

Hugo passes these CLI flags when calling the rst2html executable:

--leave-comments --initial-header-level=2

Classification

Content format Media type Identifier File extensions
Markdown text/markdown markdown markdown,md, mdown
HTML text/html html htm, html
Emacs Org Mode text/org org org
AsciiDoc text/asciidoc asciidoc ad, adoc, asciidoc
Pandoc text/pandoc pandoc pandoc, pdc
reStructuredText text/rst rst rst

When converting content to HTML, Hugo uses:

  • Native renderers for Markdown, HTML, and Emacs Org mode
  • External renderers for AsciiDoc, Pandoc, and reStructuredText

Native renderers are faster than external renderers.