From 15fc7e62b9ec3651bcd08480933f460c88624d48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Sun, 6 Oct 2024 16:45:11 +0200 Subject: [PATCH] docs: honing #567 --- .../content/configuration/modifications/_index.en.md | 4 ++-- .../configuration/modifications/_index.pir.md | 4 ++-- .../configuration/modifications/partials/index.en.md | 2 +- .../modifications/partials/index.pir.md | 2 +- .../configuration/modifications/topbar/_index.en.md | 4 ++-- .../configuration/modifications/topbar/_index.pir.md | 4 ++-- .../content/configuration/options/_index.en.md | 12 +++++++----- exampleSite/content/content/frontmatter/_index.en.md | 12 +++++++----- exampleSite/content/content/markdown.en.md | 6 +++--- 9 files changed, 27 insertions(+), 23 deletions(-) diff --git a/exampleSite/content/configuration/modifications/_index.en.md b/exampleSite/content/configuration/modifications/_index.en.md index bfb7e90fef..365552884a 100644 --- a/exampleSite/content/configuration/modifications/_index.en.md +++ b/exampleSite/content/configuration/modifications/_index.en.md @@ -1,7 +1,7 @@ +++ alwaysopen = false -description = "Edit files for advanced configuration" -title = "File Modifications" +description = "Modify files for advanced customization" +title = "Modifications" weight = 5 +++ diff --git a/exampleSite/content/configuration/modifications/_index.pir.md b/exampleSite/content/configuration/modifications/_index.pir.md index b1a31bdc91..6c3d4fdf7e 100644 --- a/exampleSite/content/configuration/modifications/_index.pir.md +++ b/exampleSite/content/configuration/modifications/_index.pir.md @@ -1,7 +1,7 @@ +++ alwaysopen = false -description = "Edit files for advanced configuration" -title = "File Modifications" +description = "Modify files for advanced customization" +title = "Modifications" weight = 5 +++ {{< piratify >}} \ No newline at end of file diff --git a/exampleSite/content/configuration/modifications/partials/index.en.md b/exampleSite/content/configuration/modifications/partials/index.en.md index e1c4c40581..03195153f0 100644 --- a/exampleSite/content/configuration/modifications/partials/index.en.md +++ b/exampleSite/content/configuration/modifications/partials/index.en.md @@ -1,7 +1,7 @@ +++ description = "Modifying partials to your needs" title = "Partials" -weight = 2 +weight = 1 +++ ## Customizable Partials diff --git a/exampleSite/content/configuration/modifications/partials/index.pir.md b/exampleSite/content/configuration/modifications/partials/index.pir.md index 3f6ad42fe1..d13d92a57f 100644 --- a/exampleSite/content/configuration/modifications/partials/index.pir.md +++ b/exampleSite/content/configuration/modifications/partials/index.pir.md @@ -1,6 +1,6 @@ +++ description = "Modifying partials to your needs" title = "Partials" -weight = 2 +weight = 1 +++ {{< piratify >}} \ No newline at end of file diff --git a/exampleSite/content/configuration/modifications/topbar/_index.en.md b/exampleSite/content/configuration/modifications/topbar/_index.en.md index 3a87148121..4cc1a09b1c 100644 --- a/exampleSite/content/configuration/modifications/topbar/_index.en.md +++ b/exampleSite/content/configuration/modifications/topbar/_index.en.md @@ -1,8 +1,8 @@ +++ description = "How to extend the topbar" options = ["editURL"] -title = "Topbar Modification" -weight = 1 +title = "Custom Topbar" +weight = 2 +++ The theme comes with a reasonably configured topbar. You can learn how to [configure the defaults in this section](configuration/appearance/topbar). diff --git a/exampleSite/content/configuration/modifications/topbar/_index.pir.md b/exampleSite/content/configuration/modifications/topbar/_index.pir.md index 9692da65ab..e3d08fbd78 100644 --- a/exampleSite/content/configuration/modifications/topbar/_index.pir.md +++ b/exampleSite/content/configuration/modifications/topbar/_index.pir.md @@ -1,6 +1,6 @@ +++ description = "How to extend the topbar" -title = "Topbarrr Modificat'n" -weight = 1 +title = "Custom Topbarrr" +weight = 2 +++ {{< piratify >}} \ No newline at end of file diff --git a/exampleSite/content/configuration/options/_index.en.md b/exampleSite/content/configuration/options/_index.en.md index 61eddd9010..5748f7a1cd 100644 --- a/exampleSite/content/configuration/options/_index.en.md +++ b/exampleSite/content/configuration/options/_index.en.md @@ -5,23 +5,25 @@ title = "Options Reference" weight = 6 +++ -You can set configuration options in your `hugo.toml`. On top of [Hugo's configuration options](https://gohugo.io/getting-started/configuration/#all-configuration-settings), you can use the following settings unique to the theme. +You can set configuration options in your `hugo.toml`. -A configurable option is marked with {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} badge throughout the documentation. +A configurable option is marked with a {{% badge style="cyan" icon="gears" title=" " %}}Option{{% /badge %}} badge throughout the documentation. + +On top of [Hugo's configuration options](https://gohugo.io/getting-started/configuration/#all-configuration-settings), you can use the following settings unique to the theme. ## Index {{% taxonomy "options" "h3" %}} -## All config options +## All Configuration Options -The values reflect example options. The defaults can be taken from the [annotated example](#annotated-config-options) below or the individual documentation. +The example reflect example values. The defaults can be taken from the [annotated example](#annotated-configuration-options) below or the individual documentation. {{< multiconfig file=hugo section=params >}} {{% include "config/_default/params.toml" %}} {{< /multiconfig >}} -## Annotated config options +## Annotated Configuration Options ````toml {title="hugo.toml"} [params] diff --git a/exampleSite/content/content/frontmatter/_index.en.md b/exampleSite/content/content/frontmatter/_index.en.md index b1e1c9bf8a..7a3b545b3c 100644 --- a/exampleSite/content/content/frontmatter/_index.en.md +++ b/exampleSite/content/content/frontmatter/_index.en.md @@ -5,23 +5,25 @@ weight = 6 +++ -Each page in Hugo **has to define** front matter. On top of [Hugo's front matter](https://gohugo.io/content-management/front-matter/#fields), you can use the following settings unique to the theme. +Each page in Hugo **has to define** front matter. -A front matter is marked with {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} badge throughout the documentation. +A configurable front matter is marked with a {{% badge style="green" icon="fa-fw fab fa-markdown" title=" " %}}Front Matter{{% /badge %}} badge throughout the documentation. + +On top of [Hugo's front matter](https://gohugo.io/content-management/front-matter/#fields), you can use the following settings unique to the theme. ## Index {{% taxonomy "frontmatter" "h3" %}} -## All Frontmatter Options +## All Front Matter -The values reflect example options. The defaults can be taken from the [annotated example](#annotated-frontmatter-options) below or the individual documentation. +The example reflect example values. The defaults can be taken from the [annotated example](#annotated-front-matter) below or the individual documentation. {{< multiconfig fm=true >}} {{% include "frontmatter.toml" %}} {{< /multiconfig >}} -## Annotated Frontmatter Options +## Annotated Front Matter ````toml {title="toml"} +++ diff --git a/exampleSite/content/content/markdown.en.md b/exampleSite/content/content/markdown.en.md index 81a2ff2f6f..96ea254fef 100644 --- a/exampleSite/content/content/markdown.en.md +++ b/exampleSite/content/content/markdown.en.md @@ -32,7 +32,7 @@ If not otherwise noted, the shown examples adhere to the [Commonmark](https://co - {{% badge color="darkgray" icon="fa-fw fab fa-github" %}}GFM{{% /badge %}} Extension on top of standard Markdown adhering to [GitHub Flavored Markdown](https://github.github.com/gfm/). -- {{% badge color="#888cc4" icon="fa-fw fab fa-markdown" %}}PHP{{% /badge %}} Extension on top of standard Markdown adhering to [PHP Markdown](https://michelf.ca/projects/php-markdown/extra/). +- {{% badge color="#888cc4" icon="fa-fw fab fa-php" %}}PHP{{% /badge %}} Extension on top of standard Markdown adhering to [PHP Markdown](https://michelf.ca/projects/php-markdown/extra/). - {{% badge color="darkorange" icon="lightbulb" %}}Pants{{% /badge %}} Extension by John Gruber adhering to [SmartyPants](https://daringfireball.net/projects/smartypants/). @@ -437,7 +437,7 @@ Markdown will automatically number each of your items consecutively. This means, ### Definitions -{{% badge color="#888cc4" icon="fa-fw fab fa-markdown" %}}PHP{{% /badge %}} Definition lists are made of terms and definitions of these terms, much like in a dictionary. +{{% badge color="#888cc4" icon="fa-fw fab fa-php" %}}PHP{{% /badge %}} Definition lists are made of terms and definitions of these terms, much like in a dictionary. A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition. @@ -646,7 +646,7 @@ Links can be simplyfied for recurring reuse by using a reference ID to later def ### Footnotes -{{% badge color="#888cc4" icon="fa-fw fab fa-markdown" %}}PHP{{% /badge %}} Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes. +{{% badge color="#888cc4" icon="fa-fw fab fa-php" %}}PHP{{% /badge %}} Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes. Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.