2020-05-31 18:17:32 +02:00
Include shortcode can include files of different types. By specifying a language, the included file will have syntax highlighting.
2020-04-30 15:37:27 +02:00
## Shortcode
```tpl
{{< /* include file="relative/path/from/hugo/root" language="go" markdown=[false|true] */>}}
```
Attributes:
| Name | Usage | default |
|---|---|---|
| file | path to the included file relative to the hugo root | empty value |
| language* | language for [syntax highlighting ](https://gohugo.io/content-management/syntax-highlighting/#list-of-chroma-highlighting-languages ) | empty value |
| markdown | included file is markdown | false |
| options | highlighting [options ](https://gohugo.io/content-management/syntax-highlighting/#highlight-shortcode ) | linenos=table |
2020-05-31 18:17:32 +02:00
\* if not set, the content will be rendered as plain HTML
2020-04-30 15:37:27 +02:00
### Include *.yml file with options
```tpl
{{< /* include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100" */>}}
```
{{< include file = "config.yaml" language = "yaml" options = "linenos=table,hl_lines=5-6,linenostart=100" > }}
### Include *.md file
Included markdown files will be rendered using the `markdownify` filter.
{{< hint warning > }}
**Location of markdown files**\
2020-05-31 18:17:32 +02:00
If you include markdown files that should not get a menu entry, place them outside the content folder or exclude them otherwise.
2020-04-30 15:37:27 +02:00
{{< / hint > }}
```tpl
2020-05-31 18:17:32 +02:00
{{< /* include file="static/includes/table.md.part" markdown="true" */>}}
2020-04-30 15:37:27 +02:00
```
2020-05-31 18:17:32 +02:00
{{< include file = "static/includes/table.md.part" markdown = "true" > }}
2020-04-30 15:37:27 +02:00
### Include *.html file
2020-05-31 18:17:32 +02:00
HTML content will be filtered by the `safeHTML` filter and added to the rendered page output.
2020-04-30 15:37:27 +02:00
```tpl
2020-05-31 18:17:32 +02:00
{{< /* include file="static/includes/example.html.part" */>}}
2020-04-30 15:37:27 +02:00
```
2020-05-31 18:17:32 +02:00
{{< include file = "static/includes/example.html.part" > }}