From 5cc1a55b43004bb71ecfcba20decd1e938a815c1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=B6ren=20Weber?= <mail@soeren-weber.de>
Date: Mon, 24 Mar 2025 00:53:04 +0100
Subject: [PATCH] docs: use tree shortcode #1067
---
docs/content/authoring/structure/index.en.md | 32 +++----
.../configuration/sidebar/menus/_index.en.md | 46 +++++-----
.../sitemanagement/multilingual/_index.en.md | 88 ++++++++++---------
.../sitemanagement/structure/_index.en.md | 29 +++---
layouts/partials/version.txt | 2 +-
5 files changed, 100 insertions(+), 97 deletions(-)
diff --git a/docs/content/authoring/structure/index.en.md b/docs/content/authoring/structure/index.en.md
index 49c05bd69d..3e4a7f839e 100644
--- a/docs/content/authoring/structure/index.en.md
+++ b/docs/content/authoring/structure/index.en.md
@@ -11,22 +11,22 @@ The theme generates the navigation menu out of the given directory structure.
Organize your site like [any other Hugo project](https://gohugo.io/content/structure/). Typically, you will have a _content_ directory with all your pages.
-````plaintext
-content
-├── log
-│ ├── first-day
-| | |── _index.md
-| │ ├── first-sub-page
-| | | |── _index.md
-| | | |── picture1.png
-| | | └── plain.txt
-│ ├── second-day
-| | |── index.md
-| | |── picture1.png
-| | └── picture2.png
-│ ├── third-day.md
-│ └── _index.md
-└── _index.md
+````tree
+- content::folder
+ - log::folder
+ - first-day::folder
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - first-sub-page::folder
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - picture1.png::file-alt::accent
+ - plain.txt::file-alt::accent
+ - second-day::folder
+ - index.md::fa-fw fab fa-markdown::secondary
+ - picture1.png::file-alt::accent
+ - picture2.png::file-alt::accent
+ - third-day.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
````
> [!note]
diff --git a/docs/content/configuration/sidebar/menus/_index.en.md b/docs/content/configuration/sidebar/menus/_index.en.md
index 416a4e8de2..d7e712f559 100644
--- a/docs/content/configuration/sidebar/menus/_index.en.md
+++ b/docs/content/configuration/sidebar/menus/_index.en.md
@@ -326,19 +326,19 @@ For both sections, the default `shortcuts` Hugo menu should be displayed as if [
Directory structure:
-````plaintext
-content
-├── log
-│ ├── first-day.md
-│ ├── second-day.md
-│ ├── third-day.md
-│ └── _index.md
-├── ship
-│ ├── cargo.md
-│ ├── midst.md
-│ ├── upper.md
-│ └── _index.md
-└── _index.md
+````tree
+- content::folder
+ - log::folder
+ - first-day.md::fa-fw fab fa-markdown::secondary
+ - second-day.md::fa-fw fab fa-markdown::secondary
+ - third-day.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - ship::folder
+ - cargo.md::fa-fw fab fa-markdown::secondary
+ - midst.md::fa-fw fab fa-markdown::secondary
+ - upper.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
````
{{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} Using [Hugo's cascade feature](https://gohugo.io/content-management/front-matter/#cascade), we can redefine the menus once in `log/_index.md` and `ship/_index.md` setting `sidebarmenus` so they will be used in all children pages.
@@ -371,16 +371,16 @@ You may have the need to add arbitrary links at some point in your menu that sho
Assume the following structure
-````plaintext
-content
-├── log
-│ ├── first-day.md
-│ ├── second-day.md
-│ ├── third-day.md
-│ └── _index.md
-├── burning-sail-incident.md
-├── kraken-incident.md
-└── _index.md
+````tree
+- content::folder
+ - log::folder
+ - first-day.md::fa-fw fab fa-markdown::secondary
+ - second-day.md::fa-fw fab fa-markdown::secondary
+ - third-day.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - burning-sail-incident.md::fa-fw fab fa-markdown::secondary
+ - kraken-incident.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
````
You now want to add a top level menu entry that points to `third-day` as separate `crows-nest-incident`.
diff --git a/docs/content/configuration/sitemanagement/multilingual/_index.en.md b/docs/content/configuration/sitemanagement/multilingual/_index.en.md
index 8d49b10914..3adbebd226 100644
--- a/docs/content/configuration/sitemanagement/multilingual/_index.en.md
+++ b/docs/content/configuration/sitemanagement/multilingual/_index.en.md
@@ -64,25 +64,26 @@ Here's how to make your site multilingual using [translations by file name](http
2. Duplicate your content files and add language codes to their file names:
- ````plaintext
- ├── content
- │ ├── log
- │ │ ├── first-day
- | | | ├── _index.en.md
- | | | └── _index.pir.md
- │ │ ├── second-day
- | | | ├── index.en.md
- | | | └── index.pir.md
- │ │ ├── third-day.en.md
- │ │ ├── third-day.pir.md
- │ │ ├── _index.en.md
- │ │ └── _index.pir.md
- │ ├── _index.en.md
- │ └── _index.pir.md
- ├── themes
- │ └── hugo-theme-relearn
- │ └── ...
- └── hugo.toml
+ ````tree
+ - [PROJECT]
+ - content::folder
+ - log::folder
+ - first-day::folder
+ - _index.en.md::fa-fw fab fa-markdown::secondary
+ - _index.pir.md::fa-fw fab fa-markdown::secondary
+ - second-day::folder
+ - index.en.md::fa-fw fab fa-markdown::secondary
+ - index.pir.md::fa-fw fab fa-markdown::secondary
+ - third-day.en.md::fa-fw fab fa-markdown::secondary
+ - third-day.pir.md::fa-fw fab fa-markdown::secondary
+ - _index.en.md::fa-fw fab fa-markdown::secondary
+ - _index.pir.md::fa-fw fab fa-markdown::secondary
+ - _index.en.md::fa-fw fab fa-markdown::secondary
+ - _index.pir.md::fa-fw fab fa-markdown::secondary
+ - themes::folder
+ - hugo-theme-relearn::folder
+ - ...::folder
+ - hugo.toml::file-alt::accent
````
## Translation by Content Directory
@@ -113,30 +114,31 @@ The theme also support [translations by content directory](https://gohugo.io/con
2. Duplicate your content files into separate directories named by their language code:
- ````plaintext
- ├── content
- │ ├── en
- | │ ├── log
- | │ │ ├── first-day
- | | | | └── _index.md
- | │ │ ├── second-day
- | | | | └── index.md
- | │ │ ├── third-day.md
- | │ │ └── _index.md
- | │ └── _index.md
- │ ├── pir
- | │ ├── log
- | │ │ ├── first-day
- | | | | └── _index.md
- | │ │ ├── second-day
- | | | | └── index.md
- | │ │ ├── third-day.md
- | │ │ └── _index.md
- | │ └── _index.md
- | ├── themes
- | │ └── hugo-theme-relearn
- | │ └── ...
- | └── hugo.toml
+ ````tree
+ - [PROJECT]
+ - content::folder
+ - en::folder
+ - log::folder
+ - first-day::folder
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - second-day::folder
+ - index.md::fa-fw fab fa-markdown::secondary
+ - third-day.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - pir::folder
+ - log::folder
+ - first-day::folder
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - second-day::folder
+ - index.md::fa-fw fab fa-markdown::secondary
+ - third-day.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - themes::folder
+ - hugo-theme-relearn::folder
+ - ...::folder
+ - hugo.toml::file-alt::accent
````
diff --git a/docs/content/configuration/sitemanagement/structure/_index.en.md b/docs/content/configuration/sitemanagement/structure/_index.en.md
index 355bb3ee18..b0f2f2af79 100644
--- a/docs/content/configuration/sitemanagement/structure/_index.en.md
+++ b/docs/content/configuration/sitemanagement/structure/_index.en.md
@@ -7,20 +7,21 @@ weight = 1
If you've followed the [Getting Started](introduction/quickstart) guide, your directory layout will look similar to this:
-````plaintext
-├── content
-│ ├── log
-│ │ ├── first-day
-| | | └── _index.md
-│ │ ├── second-day
-| | | └── index.md
-│ │ ├── third-day.md
-│ │ └── _index.md
-│ └── _index.md
-├── themes
-│ └── hugo-theme-relearn
-│ └── ...
-└── hugo.toml
+````tree
+- [PROJECT]
+ - content::folder
+ - log::folder
+ - first-day::folder
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - second-day::folder
+ - index.md::fa-fw fab fa-markdown::secondary
+ - third-day.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - _index.md::fa-fw fab fa-markdown::secondary
+ - themes::folder
+ - hugo-theme-relearn::folder
+ - ...::folder
+ - hugo.toml::file-alt::accent
````
Hugo uses a [union file system](https://gohugo.io/getting-started/directory-structure/#union-file-system), which lets you combine multiple directories.
diff --git a/layouts/partials/version.txt b/layouts/partials/version.txt
index 19e282a875..bd2e3ea287 100644
--- a/layouts/partials/version.txt
+++ b/layouts/partials/version.txt
@@ -1 +1 @@
-7.5.0+985af47e3ffb717360ce812c6f96780afc9a5ad4
\ No newline at end of file
+7.5.0+6095b777f5fc176bb5ba11614d09e746d1479442
\ No newline at end of file