nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-01-18 19:00:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: interchange leaf/branch bundle handling

Browse source 
this was an unoticed docs error
This commit is contained in:
Sören Weber 2024-04-07 22:46:28 +02:00
parent 43e9a8c376
commit b262c0b1a3
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
1 changed files with 5 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
exampleSite/content/shortcodes/attachments/index.en.md
View file

@ -9,7 +9,7 @@ The `attachments` shortcode displays a list of files attached to a page with adj
{{% attachments sort="asc" /%}}
{{% notice warning %}}
This shortcode is deprecated in favor of the new the [`resources` shortcode](shortcodes/resources). See [migration instructions](#migration) below.
This shortcode is deprecated in favor of the new [`resources` shortcode](shortcodes/resources). See [migration instructions](#migration) below.
{{% /notice %}}
## Migration
@ -28,10 +28,6 @@ Multilanguage features are not supported directly by the shortcode anymore but r
## Usage
{{% notice warning %}}
Since Hugo {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.112.0{{% /badge %}} this only works for leaf bundles. Branch bundles and simple pages must be switched to leaf bundles or you are currently locked to a Hugo version < `0.112.0`.
{{% /notice %}}
While the examples are using shortcodes with named parameter you are free to also call this shortcode from your own partials.
{{< tabs groupid="shortcode-parameter">}}
@ -76,8 +72,8 @@ The shortcode lists files found in a specific folder. The name of the folder dep
> * content
> * _index.md
> * page
> * _index.md
> * **_index.files**
> * index.md
> * **index.files**
> * attachment.pdf
2. If your page is a branch bundle, attachments must be placed in a nested `_index.files` folder, accordingly.
@ -87,8 +83,8 @@ The shortcode lists files found in a specific folder. The name of the folder dep
> * content
> * _index.md
> * page
> * index.md
> * **index.files**
> * _index.md
> * **_index.files**
> * attachment.pdf
3. For simple pages, attachments must be placed in a folder named like your page and ending with `.files`.