Skip to content

Commit 969f274

Browse files
markdumaymarkdumay
committed
fix: update markdown linter
1 parent dd0722f commit 969f274

File tree

21 files changed

+454
-396
lines changed

21 files changed

+454
-396
lines changed

‎content/en/docs/latest/advanced-settings/partial-development.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -142,16 +142,16 @@ Arguments support the following elements:
142142

143143
The following primitive types are supported.
144144

145-
| Primitive | Description |
146-
|-----------|-------------|
147-
| bool | Boolean, either `true` or `false`. The validation supports both quoted and unquoted values. Maps to the Hugo type `bool`. |
148-
| dict | A map of key-value pairs, see [collections.Dictionary](https://gohugo.io/functions/collections/dictionary/). Consider using a defined complex type instead. |
149-
| int, int64 | A whole number, including negative values. Optionally, specify the allowed value range using `options.min` and `options.max`. Maps to the Hugo type `int`. |
150-
| float, float64 | A fractional number, including negative values. Optionally, specify the allowed value range using `options.min` and `options.max`. Maps to the Hugo type `float64`. |
151-
| path | Path to a local file or directory. By convention, paths that start with `/` are relative to the repository root. When used as source argument, the base directory may be mapped to one of Hugo's mount folders (e.g. `assets`, `data`, `content`, `static`). Windows paths are mapped to Unix-style paths using forward slashes. Maps to the Hugo type `string`. |
152-
| select | A single string value from a set of options. Specify the allowed values in `options.values`. Maps to the Hugo type `string`. |
153-
| slice | An ordered list of values, see [collections.Dictionary](https://gohugo.io/functions/collections/slice/). Consider using a defined complex type instead. |
154-
| string | Free format plain text. Maps to the Hugo type `string`. |
145+
| Primitive | Description |
146+
|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
147+
| bool | Boolean, either `true` or `false`. The validation supports both quoted and unquoted values. Maps to the Hugo type `bool`. |
148+
| dict | A map of key-value pairs, see [collections.Dictionary](https://gohugo.io/functions/collections/dictionary/). Consider using a defined complex type instead. |
149+
| int, int64 | A whole number, including negative values. Optionally, specify the allowed value range using `options.min` and `options.max`. Maps to the Hugo type `int`. |
150+
| float, float64 | A fractional number, including negative values. Optionally, specify the allowed value range using `options.min` and `options.max`. Maps to the Hugo type `float64`. |
151+
| path | Path to a local file or directory. By convention, paths that start with `/` are relative to the repository root. When used as source argument, the base directory may be mapped to one of Hugo's mount folders (e.g. `assets`, `data`, `content`, `static`). Windows paths are mapped to Unix-style paths using forward slashes. Maps to the Hugo type `string`. |
152+
| select | A single string value from a set of options. Specify the allowed values in `options.values`. Maps to the Hugo type `string`. |
153+
| slice | An ordered list of values, see [collections.Dictionary](https://gohugo.io/functions/collections/slice/). Consider using a defined complex type instead. |
154+
| string | Free format plain text. Maps to the Hugo type `string`. |
155155

156156
### Supported complex types
157157

‎content/en/docs/latest/advanced-settings/scripts.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,11 @@ In addition to their integration type, you can also bundle scripts by their inte
4343

4444
Hinode uses the following naming conventions for each type of script:
4545

46-
| Integration | Basename | Description |
47-
|-----------------|-----------------------------------|-------------|
46+
| Integration | Basename | Description |
47+
|--------------|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
4848
| **critical** | `critical.bundle` | Critical scripts are bundled by intent category. The target bundle's filename uses `critical.bundle` as basename and the category name as suffix. When the category is `other`, the suffix is omitted. Localized modules trigger a language code extension. |
49-
| **core** | `core.bundle` | Core scripts are bundled similarly as critical scripts. The target bundle's filename uses `core.bundle` as basename. |
50-
| **optional** | `<module name>` | Scripts that are part of an optional module are bundled by their module name and optional category. Similar to core scripts, optional scripts bundles can also receive a language code extension. |
49+
| **core** | `core.bundle` | Core scripts are bundled similarly as critical scripts. The target bundle's filename uses `core.bundle` as basename. |
50+
| **optional** | `<module name>` | Scripts that are part of an optional module are bundled by their module name and optional category. Similar to core scripts, optional scripts bundles can also receive a language code extension. |
5151

5252
## Integration approaches
5353

@@ -57,14 +57,14 @@ Hinodes supports three types of integration approaches. The next paragraphs desc
5757

5858
The main Hinode repository includes several scripts maintained within the `assets/js` folder. You can add (or mount) your own scripts to this folder to include them in the build pipeline. Hinode supports the following directories relative to the `assets` mount point:
5959

60-
| Category | Match (glob pattern) | Target bundle |
61-
|-----------------|-----------------------------------|-------------|
62-
| `other` | `js/critical/*.js` | `/js/critical.bundle.js` |
63-
| `functional` | `js/critical/functional/**.js` | `/js/critical.bundle-functional.js` |
64-
| `analytics` | `js/critical/analytics/**.js` | `/js/critical.bundle-analytics.js` |
65-
| `performance` | `js/critical/performance/**.js` | `/js/critical.bundle-performance.js` |
60+
| Category | Match (glob pattern) | Target bundle |
61+
|-----------------|-----------------------------------|----------------------------------------|
62+
| `other` | `js/critical/*.js` | `/js/critical.bundle.js` |
63+
| `functional` | `js/critical/functional/**.js` | `/js/critical.bundle-functional.js` |
64+
| `analytics` | `js/critical/analytics/**.js` | `/js/critical.bundle-analytics.js` |
65+
| `performance` | `js/critical/performance/**.js` | `/js/critical.bundle-performance.js` |
6666
| `advertisement` | `js/critical/advertisement/**.js` | `/js/critical.bundle-advertisement.js` |
67-
| `core` | `{js/*.js,js/vendor/**.js}` | `/js/core.bundle.js` |
67+
| `core` | `{js/*.js,js/vendor/**.js}` | `/js/core.bundle.js` |
6868

6969
### Scripts embedded within a module
7070

‎content/en/docs/latest/components/abbr.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ The shortcode supports a single unnamed argument, which maps to the `key` argume
3131

3232
Define a file in the `data` folder that contains the abbreviation data. The format expects the following attributes:
3333

34-
| Attribute | Required | Description |
35-
|-----------|----------|-------------|
34+
| Attribute | Required | Description |
35+
|-----------|----------|-------------------------------------------------------------------------------------------|
3636
| id | Yes | Required key of the abbeviation. Store the key in lower case to ensure it can be matched. |
37-
| long | Yes | Required long form of the abbreviation. |
37+
| long | Yes | Required long form of the abbreviation. |
3838

3939
The following snippet defines three entries in `yml` format.
4040

‎content/en/docs/latest/components/icon.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ Use the `icon` shortcode to quickly add a Font Awesome icon to your content. You
3232
The shortcode supports both unnamed arguments and named arguments. When using unnamed arguments, all attributes are mapped to the `class` argument, separated by spaces.
3333

3434
<!-- markdownlint-disable MD037 MD058 -->
35-
| Argument | Required | Description |
36-
|-----------|----------|-------------|
37-
| class | Yes | Family, name, and styling of the icon to display. The shortcode expects the following format and order: `{family} {name} {style attributes}`. The shortcode supports the default families of the free version of Font Awesome, including shorthand notation: "fa-solid" ("fas"), "fa-regular" ("fa"), "fa-brands" ("fab"). You can omit the `fa-` prefix of the icon name. Alternatively, you can reference a custom family and icon stored in `assets/svgs/{family}/{icon}.svg`. |
38-
| style | No | Optional custom style of the icon, e.g. `--fa-animation-duration: 2s;`. Hinode disables inline styles by default, review the [Content Security Policy]({{% relref "server-headers" %}}) for more details. |
39-
| spacing | No | {{< release version="v0.21.0" short="true" button-size="sm" inline="true" >}} Optional flag to add a trailing whitespace character to optimize inline rendering, defaults to "true". |
35+
| Argument | Required | Description |
36+
|----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
37+
| class | Yes | Family, name, and styling of the icon to display. The shortcode expects the following format and order: `{family} {name} {style attributes}`. The shortcode supports the default families of the free version of Font Awesome, including shorthand notation: "fa-solid" ("fas"), "fa-regular" ("fa"), "fa-brands" ("fab"). You can omit the `fa-` prefix of the icon name. Alternatively, you can reference a custom family and icon stored in `assets/svgs/{family}/{icon}.svg`. |
38+
| style | No | Optional custom style of the icon, e.g. `--fa-animation-duration: 2s;`. Hinode disables inline styles by default, review the [Content Security Policy]({{% relref "server-headers" %}}) for more details. |
39+
| spacing | No | {{< release version="v0.21.0" short="true" button-size="sm" inline="true" >}} Optional flag to add a trailing whitespace character to optimize inline rendering, defaults to "true". |
4040
<!-- markdownlint-enable MD037 MD058 -->
4141

4242
{{< args structure="icon" group="shortcode" >}}

‎content/en/docs/latest/components/timeline.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ The shortcode supports the following arguments:
3030

3131
Define a file in the `data` folder that contains the timeline data. The format supports the following attributes:
3232

33-
| Attribute | Required | Description |
34-
|-----------|----------|-------------|
35-
| title | Yes | Required title of the timeline element. |
36-
| icon | Yes | Required class and name of a Font Awesome icon to include. The icons use the [icon shorthand notation]({{% relref "../content/icons" %}}). |
37-
| color | No | Optional [theme color]({{% relref "colors" %}}) of the timeline element, defaults to `primary`. |
38-
| date | No | Optional date of the timeline element, placed below the title. |
39-
| badge | No | Optional label of a [pill badge]({{% relref "badge#pill-badges" %}}) placed next to the title. |
40-
| url | No | Optional url of the timeline element, added as link to the title when set. The url is joined with the `release` attribute of the [documentation configuration]({{% relref "documentation#basic-configuration" %}}), unless the url is absolute (e.g. starts with `http`). |
41-
| content | No | Optional content of the timeline element, supports markdown. |
33+
| Attribute | Required | Description |
34+
|-----------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
35+
| title | Yes | Required title of the timeline element. |
36+
| icon | Yes | Required class and name of a Font Awesome icon to include. The icons use the [icon shorthand notation]({{% relref "../content/icons" %}}). |
37+
| color | No | Optional [theme color]({{% relref "colors" %}}) of the timeline element, defaults to `primary`. |
38+
| date | No | Optional date of the timeline element, placed below the title. |
39+
| badge | No | Optional label of a [pill badge]({{% relref "badge#pill-badges" %}}) placed next to the title. |
40+
| url | No | Optional url of the timeline element, added as link to the title when set. The url is joined with the `release` attribute of the [documentation configuration]({{% relref "documentation#basic-configuration" %}}), unless the url is absolute (e.g. starts with `http`). |
41+
| content | No | Optional content of the timeline element, supports markdown. |
4242

4343
The following snippet defines a single timeline element in `yml` format.
4444

‎content/en/docs/latest/configuration/color-modes.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ The argument `darkModeTint` lightens the primary color with a given percentage,
3636

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

0 commit comments

Comments
 (0)