Geekdocs
GitHub Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Includes

Include shortcode can include files of different types. By specifying a language, the included file will have syntax highlighting.

{{< 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 undefined
language language for syntax highlighting undefined
type special include type (html,page) undefined
options highlighting options linenos=table

Examples

Markdown file (default)

If no other options are specified, files will be rendered as Markdown using the RenderString function.

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.
{{< include file="/static/_includes/example.md.part" >}}

Example Mardown include

File including a simple Markdown table.

Head 1 Head 2 Head 3
1 2 3

Language files

This method can be used to include source code files and keep them automatically up to date.

{{< include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100" >}}
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
---
baseURL: https://geekdocs.de/
title: Geekdocs
theme: hugo-geekdoc
pygmentsUseClasses: true
pygmentsCodeFences: true
timeout: 180000
pluralizeListTitles: false

disablePathToLower: true
enableGitInfo: true

enableRobotsTXT: true

markup:
  goldmark:
    renderer:
      unsafe: true
  tableOfContents:
    startLevel: 1
    endLevel: 9

taxonomies:
  tag: tags

outputs:
  home:
    - HTML
  page:
    - HTML
  section:
    - HTML
  taxonomy:
    - HTML
  term:
    - HTML

params:
  geekdocToC: 3
  geekdocTagsToMenu: true

  geekdocRepo: https://github.com/thegeeklab/hugo-geekdoc
  geekdocEditPath: edit/main/exampleSite/content

  geekdocSearch: true
  geekdocSearchShowParent: true

  geekdocLegalNotice: https://thegeeklab.de/legal-notice/#contact-information
  geekdocPrivacyPolicy: https://thegeeklab.de/legal-notice/#privacy-policy

  geekdocImageLazyLoading: true
  geekdocDarkModeDim: true

Special include types

HTML

HTML content will be filtered by the safeHTML filter and added to the rendered page output.

{{< include file="/static/_includes/example.html.part" >}}

Example HTML include

This is heading 4

This is heading 5
This is heading 6

Pages

In some situations, it can be helpful to include Markdown files that also contain shortcodes. While the default method works fine to render plain Markdown, shortcodes are not parsed. The only way to get this to work is to use Hugo pages. There are several ways to structure these include pages, so whatever you do, keep in mind that Hugo needs to be able to render and serve these files as regular pages! How it works:

  1. First you need to create a directory within your content directory. For this example site _includes is used.
  2. To prevent the theme from embedding the page in the navigation, create a file _includes/_index.md and add GeekdocHidden: true to the front matter.
  3. Place your Markdown files within the _includes folder e.g. /_includes/include-page.md. Make sure to name it *.md.
  4. Include the page using {{< include file="/_includes/include-page.md" >}}.

Resulting structure should look like this:

_includes/
 ├── include-page.md
 └── _index.md

Example page include

Example Shortcode
Shortcode used in an include page.
Head 1 Head 2 Head 3
1 2 3