hugo-theme-relearn/exampleSite/content/shortcodes/include/index.en.md

+++ description = "Displays content from other files" title = "Include" +++

The include shortcode includes other pages, resources or files from your project.

Usage

While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.

{{< tabs groupid="shortcode-parameter">}} {{% tab title="shortcode" %}}

{{%/* include file="shortcodes/include/INCLUDE_ME.md" */%}}

{{% /tab %}} {{% tab title="shortcode (positional)" %}}

{{%/* include "shortcodes/include/INCLUDE_ME.md" */%}}

{{% /tab %}} {{% tab title="partial" %}}

{{ partial "shortcodes/include .html" (dict
  "page" .
  "file" "shortcodes/include/INCLUDE_ME.md"
)}}

{{% /tab %}} {{< /tabs >}}

The included files can even contain Markdown and will be taken into account when generating the table of contents.

Parameter

Name	Position	Default	Notes
file	1	<empty>	The path to the page, resource or file to be included. Page and resource paths adhere to Hugo's logical path. If not found by logical path it falls back to Hugo's build-in readFile function
hidefirstheading	2	false	When true and the included file contains headings, the first heading will be hidden. This comes in handy, eg. if you include otherwise standalone Markdown files.

Examples

Arbitrary Content

{{%/* include "shortcodes/include/INCLUDE_ME.md" */%}}

{{% include "shortcodes/include/INCLUDE_ME.md" %}}