mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-22 23:37:53 +00:00
docs: honing #567
This commit is contained in:
Sören Weber
parent
e292293675
commit
15fc7e62b9
9 changed files with 27 additions and 23 deletions
|
|
@ -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
|
||||
+++
|
||||
|
||||
|
|
|
|||
|
|
@ -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 >}}
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
+++
|
||||
description = "Modifying partials to your needs"
|
||||
title = "Partials"
|
||||
weight = 2
|
||||
weight = 1
|
||||
+++
|
||||
|
||||
## Customizable Partials
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
description = "Modifying partials to your needs"
|
||||
title = "Partials"
|
||||
weight = 2
|
||||
weight = 1
|
||||
+++
|
||||
{{< piratify >}}
|
||||
|
|
@ -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).
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
+++
|
||||
description = "How to extend the topbar"
|
||||
title = "Topbarrr Modificat'n"
|
||||
weight = 1
|
||||
title = "Custom Topbarrr"
|
||||
weight = 2
|
||||
+++
|
||||
{{< piratify >}}
|
||||
|
|
@ -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]
|
||||
|
|
|
|||
|
|
@ -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"}
|
||||
+++
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue