From 7a5f4bf6871f07a1e8250ab96c5946fb6e176473 Mon Sep 17 00:00:00 2001 From: Salim B Date: Mon, 18 Nov 2024 21:34:25 +0100 Subject: [PATCH 1/3] docs: Add more cross refs and fix formatting --- content/en/getting-started/glossary.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/getting-started/glossary.md b/content/en/getting-started/glossary.md index 0e63c790d0..600e24714c 100644 --- a/content/en/getting-started/glossary.md +++ b/content/en/getting-started/glossary.md @@ -60,7 +60,7 @@ A data type with two possible values, either `true` or `false`. ###### branch bundle -A directory that contains an _index.md file and zero or more [resources](#resource). Analogous to a physical branch, a branch bundle may have descendants including leaf bundles and other branch bundles. Top level directories with or without _index.md files are also branch bundles. This includes the home page. See [details](/content-management/page-bundles/). +A directory that contains an `_index.md` file and zero or more [resources](#resource). Analogous to a physical branch, a branch bundle may have descendants including [leaf bundles](#leaf-bundle) and other branch bundles. Top level directories with or without `_index.md` files are also branch bundles. This includes the home page. See [details](/content-management/page-bundles/). ###### build @@ -167,7 +167,7 @@ A file within the assets directory, or within any directory [mounted](/hugo-modu ###### headless bundle -An unpublished leaf or branch bundle whose content and resources you can include in other pages. See [build options](/content-management/build-options/). +An unpublished [leaf](#leaf-bundle) or [branch bundle](#branch-bundle) whose content and resources you can include in other pages. See [build options](/content-management/build-options/). ###### identifier @@ -205,7 +205,7 @@ See [template](#template). ###### leaf bundle -A directory that contains an index.md file and zero or more [resources](#resource). Analogous to a physical leaf, a leaf bundle is at the end of a branch. It has no descendants. See [details](/content-management/page-bundles/). +A directory that contains an `index.md` file and zero or more [resources](#resource). Analogous to a physical leaf, a leaf bundle is at the end of a [branch](#branch-bundle). It has no descendants. See [details](/content-management/page-bundles/). ###### list page @@ -373,7 +373,7 @@ Conceptually, a [map](#map) with [methods](#method) to set, get, update, and del ###### section -A top-level content directory, or any content directory with an _index.md file. A content directory with an _index.md file is also known as a [branch bundle](/getting-started/glossary/#branch-bundle). Section templates receive one or more page [collections](#collection) in [context](#context). See [details](/content-management/sections/). +A top-level content directory, or any content directory with an `_index.md` file. A content directory with an `_index.md` file is also known as a [branch bundle](/getting-started/glossary/#branch-bundle). Section templates receive one or more page [collections](#collection) in [context](#context). See [details](/content-management/sections/). ###### section page From c550a25bb1cdf6d2ddd388437e5739fe7859ef6b Mon Sep 17 00:00:00 2001 From: Salim B Date: Tue, 19 Nov 2024 00:10:15 +0100 Subject: [PATCH 2/3] docs: Be consistent about formatting single chars --- content/en/getting-started/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/getting-started/glossary.md b/content/en/getting-started/glossary.md index 600e24714c..3643386f85 100644 --- a/content/en/getting-started/glossary.md +++ b/content/en/getting-started/glossary.md @@ -108,7 +108,7 @@ A template called with the `.Page.Render` method. See [details](/templates/ ###### context -Represented by a dot "." within a [template action](#template-action), context is the current location in a data structure. For example, while iterating over a [collection](#collection) of pages, the context within each iteration is the page's data structure. The context received by each template depends on template type and/or how it was called. See [details](/templates/introduction/#context). +Represented by a dot (`.`) within a [template action](#template-action), context is the current location in a data structure. For example, while iterating over a [collection](#collection) of pages, the context within each iteration is the page's data structure. The context received by each template depends on template type and/or how it was called. See [details](/templates/introduction/#context). ###### default sort order From 73e58ca58249e315eeb671cd183a033fed353bb1 Mon Sep 17 00:00:00 2001 From: Salim B Date: Tue, 19 Nov 2024 00:13:03 +0100 Subject: [PATCH 3/3] docs: format single char as code --- content/en/hugo-modules/use-modules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/hugo-modules/use-modules.md b/content/en/hugo-modules/use-modules.md index d14379a106..752a48de05 100644 --- a/content/en/hugo-modules/use-modules.md +++ b/content/en/hugo-modules/use-modules.md @@ -148,7 +148,7 @@ use . use ../gohugoioTheme ``` -Using the `use` directive, list all the modules you want to work on, pointing to its relative location. As in the example above, it's recommended to always include the main project (the ".") in the list. +Using the `use` directive, list all the modules you want to work on, pointing to its relative location. As in the example above, it's recommended to always include the main project (the `.`) in the list. With that you can start the Hugo server with that workspace enabled: