hugo-geekdoc/exampleSite/content/shortcodes/includes.md
Robert Kaussow 5e105c9ff4
feat: auto-load custom svg sprites from assets folder (#79)
BREAKING CHANGE: Build-in icons are prefixed with `gdoc_` now. If you use build-in icons in e.g. menus you have to rename these references!
2021-03-03 21:07:59 +01:00

61 lines
2.4 KiB
Markdown

Include shortcode can include files of different types. By specifying a language, the included file will have syntax highlighting.
## 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 |
\* if not set, the content will be rendered as plain HTML
<!-- prettier-ignore -->
### Include \*.yml file with options
```tpl
{{</* include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100" */>}}
```
<!-- spellchecker-disable -->
{{< include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100">}}
<!-- spellchecker-enable -->
### Include \*.md file
Included markdown files will be rendered using the `RenderString` [function](https://gohugo.io/functions/renderstring/).
{{< hint warning >}}
**Location of markdown files**\
If you include markdown files that should not get a menu entry, place them outside the content folder or exclude them otherwise.
{{< /hint >}}
```tpl
{{</* include file="static/includes/table.md.part" markdown="true" */>}}
```
<!-- spellchecker-disable -->
{{< include file="static/includes/table.md.part" markdown="true" >}}
<!-- spellchecker-enable -->
### Include \*.html file
HTML content will be filtered by the `safeHTML` filter and added to the rendered page output.
```tpl
{{</* include file="static/includes/example.html.part" */>}}
```
{{< include file="static/includes/example.html.part" >}}