github/hugo-geekdoc
0
0
Fork 0
mirror of https://github.com/thegeeklab/hugo-geekdoc.git synced 2024-11-24 22:00:39 +00:00
Code Issues Projects Releases Wiki Activity

cleanup include shortcode docs

Browse Source
This commit is contained in:
Robert Kaussow 2022-01-10 23:39:19 +01:00
parent e9a07f78d2
commit 8a741d82d8
Signed by: xoxys
GPG Key ID: 4E692A2EAECC03C0
1 changed files with 1 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
exampleSite/content/shortcodes/includes.md
View File

@ -80,7 +80,7 @@ In some situations, it can be helpful to include Markdown files that also contai
1. First you need to create a directory **within** your content directory. For this example site `_includes` is used. 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. 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`. 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" */>}}`. 4. Include the page using `{{</* include file="/_includes/include-page.md" type="page" */>}}`.
Resulting structure should look like this: Resulting structure should look like this:
@ -90,11 +90,4 @@ _includes/
└── _index.md └── _index.md
``` ```
Specify the page include:
<!-- prettier-ignore -->
```tpl
{{</* include file="/_includes/include-page.md" type="page" */>}}
```
{{< include file="/_includes/include-page.md" type="page" >}} {{< include file="/_includes/include-page.md" type="page" >}}