Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
canonifyAssetsURLs = false
footerBelowFold = false
loading = "lazy"
titleCase = true
[main.externalLinks]
cue = true
tab = true
Expand Down
6 changes: 5 additions & 1 deletion content/en/docs/latest/configuration/color-modes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Color modes
description: Add light mode and dark mode support to your website.
date: 2023-08-14
date: 2025-01-20
layout: docs
---

Expand Down Expand Up @@ -34,10 +34,14 @@ Contrast is an important aspect of your site accessibility. The {{< link wcag_co

The argument `darkModeTint` lightens the primary color with a given percentage, while `darkModeShade` darkens the primary background color. You can adjust these settings in the `style` section of the `site parameters`.

{{% comment %}}<!-- markdownlint-disable MD058 -->{{% /comment %}}
{{< table wrap=true >}}
| Setting | Default | Description |
|---------------|---------|-------------|
| darkModeShade | "20%" | Darkens the primary background color in dark mode with a given percentage, defaults to 20%. |
| darkModeTint | "40%" | Lightens the primary color in dark mode with a given percentage, defaults to 40%. |
{{< /table >}}
{{% comment %}}<!-- markdownlint-enable MD058 -->{{% /comment %}}

## Sass

Expand Down
14 changes: 13 additions & 1 deletion content/en/docs/latest/configuration/documentation.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Documentation
description: Configure versioned documentation
date: 2023-07-03
date: 2025-01-20
layout: docs
---

Expand All @@ -11,12 +11,16 @@ Hinodes supports the configuration of documentation pages. You can either mainta

The configuration of the documentation pages is set in the `docs` section of the site parameters. The following settings are supported:

{{% comment %}}<!-- markdownlint-disable MD058 -->{{% /comment %}}
{{< table wrap=true >}}
| Setting | Default | Description |
|--------------|---------|-------------|
| version | - | Default version to use in documentation links, only applicable when no other versions have been defined (see [next paragraph]({{% relref "documentation#versioned-documentation" %}})). |
| basePath | - | Base path to use for file references. |
| github | - | Repository URL for the docs site, overrides `schema/github` in `config/_default/params.toml`. |
| release | - | Release url for the docs site, e.g. `https://github.com/gethinode/hinode/releases/tag/`. This setting is used by the [release shortcode]({{% relref "release" %}}) and [timeline shortcode]({{% relref "timeline" %}}).
{{< /table >}}
{{% comment %}}<!-- markdownlint-enable MD058 -->{{% /comment %}}

The below configuration shows the default configuration set in `config/_default/params.toml`.

Expand All @@ -26,19 +30,27 @@ The below configuration shows the default configuration set in `config/_default/

Use the following extended settings in the `docs` section of the `site parameters` to enable versioned documentation:

{{% comment %}}<!-- markdownlint-disable MD058 -->{{% /comment %}}
{{< table wrap=true >}}
| Setting | Default | Description |
|-----------------|---------|-------------|
| contentPath | - | Defines the path (usually a section) relative to the `content` folder that maintains the documentation. Each release is expected to be stored in a separate folder within this folder. For example, the documentation with version `1.0` is expected to be maintained in `content/en/docs/1.0` (when using English as default language). |
| overview | - | If set, adds a version overview link to the version switcher in the main navigation, for example `/docs/versions/`. |
| latest | - | Defines the latest available version, used by `checkVersion` to validate if a version is current. |
| checkVersion | false | If set, adds an alert to inform your users that they are not looking at the latest version of the available documentation. Specify the latest available version in latest. The alert links to the `latestURL`. |
| latestURL | - | Link used by `checkVersion` when a newer version has been detected, e.g. `https://version-demo.gethinode.com/docs/`. |
{{< /table >}}
{{% comment %}}<!-- markdownlint-enable MD058 -->{{% /comment %}}

Add each available version to `[[docs.releases]]`. The releases support the following arguments:

{{% comment %}}<!-- markdownlint-disable MD058 -->{{% /comment %}}
{{< table wrap=true >}}
| Setting | Default | Description |
|-----------|---------|-------------|
| label | - | Name of the release version, e.g. `v1.0`. When `url` is empty, the label is used for grouping instead. |
| url | - | Local URL of the release, e.g. `/docs/1.0/`. |
| latest | false | If set, adds the suffix `latest` to the label in the version switcher. |
| redirect | - | If set, generates a server-side rewrite rule. You will need to [configure server-side redirection]({{% relref "server-side-redirection" %}}) too. |
{{< /table >}}
{{% comment %}}<!-- markdownlint-enable MD058 -->{{% /comment %}}
Loading
Loading