wompmacho/docs-public
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

take 4
All checks were successful
deploy-docs / build-and-deploy (push) Successful in 49s
Details

Browse Source
This commit is contained in:
Michael
2026-04-12 06:58:02 +00:00
parent ac4cbf89ec
commit 0b70afc5eb
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
projects/hugo/hugo_shortcodes.md
View File

@@ -16,19 +16,19 @@ Custom shortcodes defined in `layouts/shortcodes/`.
* **`include`**: Inject the contents of external files into your page. Supports local Hugo content paths and absolute paths mounted from the host (e.g., `/srv/configs/...`, `/srv/dev/hugo/wiki/...`). * **`include`**: Inject the contents of external files into your page. Supports local Hugo content paths and absolute paths mounted from the host (e.g., `/srv/configs/...`, `/srv/dev/hugo/wiki/...`).
**CRITICAL: Angle Brackets (`< >`) vs. Percentage Signs (`% %`)** **CRITICAL: Angle Brackets (`< >`) vs. Percentage Signs (`% %`)**
* Use **`{{% include %}}`** when you want the included text to be **parsed as Markdown**. This is required when including other `.md` files so their headers, lists, and links render properly. * Use **`&#123;&#123;% include ... %&#125;&#125;`** when you want the included text to be **parsed as Markdown**. This is required when including other `.md` files so their headers, lists, and links render properly.
* Use **`{{< include >}}`** to output the raw text directly *without* Markdown processing. * Use **`&#123;&#123;< include ... >&#125;&#125;`** to output the raw text directly *without* Markdown processing.
**Example 1: Including another Markdown file** **Example 1: Including another Markdown file**
```markdown ```markdown
{{% /* include "/srv/dev/hugo/wiki/README.md" */ %}} &#123;&#123;% include "/srv/dev/hugo/wiki/README.md" %&#125;&#125;
``` ```
**Example 2: Including raw code into a Code Block** **Example 2: Including raw code into a Code Block**
Wrap the shortcode in standard Markdown code fences to syntax-highlight an external configuration file: Wrap the shortcode in standard Markdown code fences to syntax-highlight an external configuration file:
````markdown ````markdown
```yaml ```yaml
{{% /* include "/srv/configs/docker_compose/homepage/docker-compose.yaml" */ %}} &#123;&#123;% include "/srv/configs/docker_compose/homepage/docker-compose.yaml" %&#125;&#125;
``` ```
```` ````
* **`video`**: Embed local or remote videos. * **`video`**: Embed local or remote videos.