updated docs

This commit is contained in:
Nuno Coração 2023-08-17 22:12:46 +01:00
parent 52bbe6ff93
commit f55ba5bb64
2 changed files with 4 additions and 3 deletions

View file

@ -22,7 +22,7 @@ defaultFeaturedImage = "/img/ocean.jpg"
highlightCurrentMenuArea = true highlightCurrentMenuArea = true
smartTOC = true smartTOC = true
smartTOCHideUnfocusedChildren = true smartTOCHideUnfocusedChildren = false
[header] [header]
layout = "fixed" # valid options: basic, fixed, fixed-fill, fixed-fill-blur layout = "fixed" # valid options: basic, fixed, fixed-fill, fixed-fill-blur

View file

@ -71,6 +71,7 @@ The theme currently supports the following languages by default:
| 🇮🇩 Indonesian | `id` | | 🇮🇩 Indonesian | `id` |
| 🇮🇹 Italian | `it` | | 🇮🇹 Italian | `it` |
| 🇯🇵 Japanese | `ja` | | 🇯🇵 Japanese | `ja` |
| 🇰🇷 Korean | `ko` |
| 🇵🇱 Polish | `pl` | | 🇵🇱 Polish | `pl` |
| 🇧🇷 Portuguese (Brazil) | `pt-br` | | 🇧🇷 Portuguese (Brazil) | `pt-br` |
| 🇵🇹 Portuguese (Portugal) | `pt-pt` | | 🇵🇹 Portuguese (Portugal) | `pt-pt` |
@ -110,8 +111,8 @@ The default file can be used as a template to create additional languages, or re
#### Params #### Params
<!-- prettier-ignore-start --> <!-- prettier-ignore-start -->
| Name | Default | Description | | Name | Default | Description |
| --------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `params.displayName` | `"EN"` | The name used when the language appears on the website. | | `params.displayName` | `"EN"` | The name used when the language appears on the website. |
| `params.isoCode` | `"en"` | The ISO language code for HTML metadata purposes. It can be a top-level language (ie. `en`) or a sub-variant (ie. `en-AU`). | | `params.isoCode` | `"en"` | The ISO language code for HTML metadata purposes. It can be a top-level language (ie. `en`) or a sub-variant (ie. `en-AU`). |
| `params.rtl` | `false` | Whether or not this is a RTL language. Set to `true` to reflow content from right-to-left. Blowfish fully supports using RTL and LTR languages at the same time and will dynamically adjust to both. | | `params.rtl` | `false` | Whether or not this is a RTL language. Set to `true` to reflow content from right-to-left. Blowfish fully supports using RTL and LTR languages at the same time and will dynamically adjust to both. |