mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-23 07:47:54 +00:00
Example site: fixing typos
This commit is contained in:
Andreas Deininger
parent
114e97f1f9
commit
a5cddb7142
18 changed files with 64 additions and 64 deletions
|
|
@ -322,7 +322,7 @@
|
|||
|
||||
### Fixes
|
||||
|
||||
- [**bug**] theme: fix IE11 incompatiblities [#234](https://github.com/McShelby/hugo-theme-relearn/issues/234)
|
||||
- [**bug**] theme: fix IE11 incompatibilities [#234](https://github.com/McShelby/hugo-theme-relearn/issues/234)
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -330,7 +330,7 @@
|
|||
|
||||
### Enhancements
|
||||
|
||||
- [**feature**] i18n: add traditional chinese translation [#233](https://github.com/McShelby/hugo-theme-relearn/issues/233)
|
||||
- [**feature**] i18n: add traditional Chinese translation [#233](https://github.com/McShelby/hugo-theme-relearn/issues/233)
|
||||
- [**feature**] menu: expand/collapse menu items without navigation [#231](https://github.com/McShelby/hugo-theme-relearn/issues/231)
|
||||
- [**feature**] print: add option to print whole chapter [#230](https://github.com/McShelby/hugo-theme-relearn/issues/230)
|
||||
- [**feature**][**breaking**] theme: apply user supplied content footer below content [#229](https://github.com/McShelby/hugo-theme-relearn/issues/229)
|
||||
|
|
@ -733,14 +733,14 @@
|
|||
- [**feature**] menu: control menu expansion with alwaysopen parameter [#49](https://github.com/McShelby/hugo-theme-relearn/issues/49)
|
||||
- [**feature**] include: new shortcode to include other files [#43](https://github.com/McShelby/hugo-theme-relearn/issues/43)
|
||||
- [**feature**] theme: adjust print styles [#35](https://github.com/McShelby/hugo-theme-relearn/issues/35)
|
||||
- [**feature**][**change**] code highligher: switch to standard hugo highlighter [#32](https://github.com/McShelby/hugo-theme-relearn/issues/32)
|
||||
- [**feature**][**change**] code highlighter: switch to standard hugo highlighter [#32](https://github.com/McShelby/hugo-theme-relearn/issues/32)
|
||||
|
||||
### Fixes
|
||||
|
||||
- [**bug**][**change**] arrow-nav: default sorting ignores ordersectionsby [#63](https://github.com/McShelby/hugo-theme-relearn/issues/63)
|
||||
- [**bug**][**change**] children: default sorting ignores ordersectionsby [#62](https://github.com/McShelby/hugo-theme-relearn/issues/62)
|
||||
- [**bug**][**change**] arrow-nav: fix broken links on (and below) hidden pages [#61](https://github.com/McShelby/hugo-theme-relearn/issues/61)
|
||||
- [**bug**] theme: remove superflous singular taxonomy from taxonomy title [#46](https://github.com/McShelby/hugo-theme-relearn/issues/46)
|
||||
- [**bug**] theme: remove superfluous singular taxonomy from taxonomy title [#46](https://github.com/McShelby/hugo-theme-relearn/issues/46)
|
||||
- [**bug**][**change**] theme: missing --MENU-HOME-LINK-HOVER-color in documentation [#45](https://github.com/McShelby/hugo-theme-relearn/issues/45)
|
||||
- [**bug**] theme: fix home link when base URL has some path [#44](https://github.com/McShelby/hugo-theme-relearn/issues/44)
|
||||
|
||||
|
|
|
|||
|
|
@ -16,17 +16,17 @@ This theme defines the following partials :
|
|||
- `menu.html`: left menu. _Not meant to be overwritten_
|
||||
- `search.html`: search box. _Not meant to be overwritten_
|
||||
- `custom-header.html`: custom headers in page. Meant to be overwritten when adding CSS imports. Don't forget to include `style` HTML tag directive in your file.
|
||||
- `custom-footer.html`: custom footer in page. Meant to be overwritten when adding Javacript. Don't forget to include `javascript` HTML tag directive in your file.
|
||||
- `custom-footer.html`: custom footer in page. Meant to be overwritten when adding JavaScript. Don't forget to include `javascript` HTML tag directive in your file.
|
||||
- `favicon.html`: the favicon
|
||||
- `heading-pre.html`: side-wide configuration to prepend to pages title headings. If you override this, it is your responsiblity to take the page's `headingPre` setting into account.
|
||||
- `heading-post.html`: side-wide configuration to append to pages title headings. If you override this, it is your responsiblity to take the page's `headingPost` setting into account.
|
||||
- `heading-pre.html`: side-wide configuration to prepend to pages title headings. If you override this, it is your responsibility to take the page's `headingPre` setting into account.
|
||||
- `heading-post.html`: side-wide configuration to append to pages title headings. If you override this, it is your responsibility to take the page's `headingPost` setting into account.
|
||||
- `logo.html`: the logo, on top left hand corner
|
||||
- `meta.html`: HTML meta tags, if you want to change default behavior
|
||||
- `menu-pre.html`: side-wide configuration to prepend to menu items. If you override this, it is your responsiblity to take the page's `menuPre` setting into account.
|
||||
- `menu-post.html`: side-wide configuration to append to menu items. If you override this, it is your responsiblity to take the page's `menuPost` setting into account.
|
||||
- `menu-pre.html`: side-wide configuration to prepend to menu items. If you override this, it is your responsibility to take the page's `menuPre` setting into account.
|
||||
- `menu-post.html`: side-wide configuration to append to menu items. If you override this, it is your responsibility to take the page's `menuPost` setting into account.
|
||||
- `menu-footer.html`: footer of the the left menu
|
||||
- `toc.html`: table of contents
|
||||
- `content.html`: the content page itself. This can be overridden if you wan't to display page's meta data above or below the content.
|
||||
- `content.html`: the content page itself. This can be overridden if you want to display page's meta data above or below the content.
|
||||
- `content-footer`: footer below the content, has a default implementation but you can overwrite it if you don't like it.
|
||||
## Change the logo
|
||||
|
||||
|
|
@ -39,7 +39,7 @@ The size of the logo will adapt automatically
|
|||
|
||||
## Change the favicon
|
||||
|
||||
If your favicon is a SVG, PNG or ICO, just drop off your image in your local `static/images/` folder and name it `favicon.svg`, `favicon.png` or `favicon.ico` respectivly.
|
||||
If your favicon is a SVG, PNG or ICO, just drop off your image in your local `static/images/` folder and name it `favicon.svg`, `favicon.png` or `favicon.ico` respectively.
|
||||
|
||||
If no favicon file is found, the theme will lookup the alternative filename `logo` in the same location and will repeat the search for the list of supported file types.
|
||||
|
||||
|
|
@ -64,11 +64,11 @@ Set the `themeVariant` value with the name of your theme file. That's it!
|
|||
themeVariant = "relearn-light"
|
||||
```
|
||||
|
||||
In the above exaple your theme file has to be named `theme-relearn-light.css`
|
||||
In the above example your theme file has to be named `theme-relearn-light.css`
|
||||
|
||||
### Multiple variants
|
||||
|
||||
You can also set multiple variants. In this case, the first variant is the default choosen on first view and a variant switch will be shown in the menu footer.
|
||||
You can also set multiple variants. In this case, the first variant is the default chosen on first view and a variant switch will be shown in the menu footer.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
|
|
@ -77,7 +77,7 @@ You can also set multiple variants. In this case, the first variant is the defau
|
|||
```
|
||||
|
||||
{{% notice tip %}}
|
||||
If you want to switch the syntax highlightning theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation [according to Hugo's documentation](https://gohugo.io/content-management/syntax-highlighting/), and `@import` this stylesheet in your color variant stylesheet. For an example, take a look into `theme-relearn-light.css` and `config.toml` of the exampleSite.
|
||||
If you want to switch the syntax highlighting theme together with your color variant, generate a syntax highlighting stylesheet and configure your installation [according to Hugo's documentation](https://gohugo.io/content-management/syntax-highlighting/), and `@import` this stylesheet in your color variant stylesheet. For an example, take a look into `theme-relearn-light.css` and `config.toml` of the exampleSite.
|
||||
{{% /notice %}}
|
||||
|
||||
### Roll your own
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ The graph is interactive and reflect the current colors. You can click on any of
|
|||
|
||||
The arrowed lines reflects how colors are inherited thru different parts of the theme if the descendent isn't overwritten. If you want to delete a color and let it inherit from its parent, just delete the value from the input field.
|
||||
|
||||
To better understand this select the `neon` variant and modify the differnet heading colors. There, colors for the heading `h2`, `h3` and `h4` are explicitly set. `h5` is not set and inherits its value from `h4`. `h6` is also not set and inherits its value from `h5`.
|
||||
To better understand this select the `neon` variant and modify the different heading colors. There, colors for the heading `h2`, `h3` and `h4` are explicitly set. `h5` is not set and inherits its value from `h4`. `h6` is also not set and inherits its value from `h5`.
|
||||
|
||||
Once you've changed a color, the variant switch will show a "My custom variant" entry and your changes are stored in the browser. You can change pages and even close the browser without losing your changes.
|
||||
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
- **Change**: The frontmatter options `pre` / `post` were renamed to `menuPre` / `menuPost`. The old options will still be used if the new options aren't set. Therefore you don't need to change anything after the upgrade.
|
||||
|
||||
- **New**: Adding new partials `heading-pre.html` / `heading-post.html` and according frontmatter options `headingPre` / `headingPost` to modifiy the way your page`s main heading gets styled.
|
||||
- **New**: Adding new partials `heading-pre.html` / `heading-post.html` and according frontmatter options `headingPre` / `headingPost` to modify the way your page`s main heading gets styled.
|
||||
|
||||
- **New**: The new shortcode `math` is available to add beautiful math and chemical formulae. See the [documentation]({{% relref "shortcodes/math" %}}) for available features. This feature will not work with Internet Explorer 11.
|
||||
|
||||
|
|
@ -77,11 +77,11 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
- **Breaking**: The second parameter for the [`include` shortcode]({{% relref "shortcodes/tabs" %}}) was switched in meaning and was renamed from `showfirstheading` to `hidefirstheading`. If you haven't used this parameter in your shortcode, the default behavior hasn't changed and you don't need to change anything.
|
||||
|
||||
If you've used the second boolean parameter, you have to rename it and invert its value to achive the same behavior.
|
||||
If you've used the second boolean parameter, you have to rename it and invert its value to achieve the same behavior.
|
||||
|
||||
- **Change**: Previously, if the [`tabs` shortcode]({{% relref "shortcodes/tabs" %}}) could not find a tab item because, the tabs ended up empty. Now the first tab is selected instead.
|
||||
|
||||
- **Change**: The `landingPageURL` was removed from `config.toml`. You can savely remove this aswell from your configuration as it is not used anymore. The theme will detect the landing page URL automatically.
|
||||
- **Change**: The `landingPageURL` was removed from `config.toml`. You can safely remove this as well from your configuration as it is not used anymore. The theme will detect the landing page URL automatically.
|
||||
|
||||
- **New**: All shortcodes can now be also called from your partials. Examples for this are added to the documentation of each shortcode.
|
||||
|
||||
|
|
@ -89,7 +89,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
## 4.1.0
|
||||
|
||||
- **New**: While fixing issues with the search functionality for non latin languages, you can now [configure to have multiple languages on a single page]({{% relref "cont/i18n/#search-with-mixed-language-support" %}}).
|
||||
- **New**: While fixing issues with the search functionality for non Latin languages, you can now [configure to have multiple languages on a single page]({{% relref "cont/i18n/#search-with-mixed-language-support" %}}).
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -97,7 +97,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
- **Breaking**: The `custom_css` config parameter was removed from the configuration. If used in an existing installation, it can be achieved by overriding the `custom-header.html` template in a much more generic manner.
|
||||
|
||||
- **Breaking**: Because anchor hover color was not configurable without introducing more complexitity to the variant stylesheets, we decided to remove `--MAIN-ANCHOR-color` instead. You don't need to change anything in your custom color stylesheet as the anchors now get their colors from `--MAIN-LINK-color` and `--MAIN-ANCHOR-HOVER-color` respectivley.
|
||||
- **Breaking**: Because anchor hover color was not configurable without introducing more complexity to the variant stylesheets, we decided to remove `--MAIN-ANCHOR-color` instead. You don't need to change anything in your custom color stylesheet as the anchors now get their colors from `--MAIN-LINK-color` and `--MAIN-ANCHOR-HOVER-color` respectively.
|
||||
|
||||
- **New**: All shortcodes now support named parameter. The positional parameter are still supported but will not be enhanced with new features, so you don't need to change anything in your installation.
|
||||
|
||||
|
|
@ -127,7 +127,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
## 3.3.0
|
||||
|
||||
- **New**: Introduction of new CSS variables to set the font. The theme distinguishs between `--MAIN-font` for all content text and `--CODE-font` for inline or block code. There are additional overrides for all headings. See the [theme variant generator]({{%relref "basics/generator" %}}) of the exampleSite for all available variables.
|
||||
- **New**: Introduction of new CSS variables to set the font. The theme distinguishes between `--MAIN-font` for all content text and `--CODE-font` for inline or block code. There are additional overrides for all headings. See the [theme variant generator]({{%relref "basics/generator" %}}) of the exampleSite for all available variables.
|
||||
|
||||
- **New**: The new shortcode `swagger` is available to include a UI for REST OpenAPI Specifications. See the [documentation]({{% relref "shortcodes/swagger" %}}) for available features. This feature will not work with Internet Explorer 11.
|
||||
|
||||
|
|
@ -169,7 +169,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
- **New**: With this release you are now capable to define your own *dark mode* variants.
|
||||
|
||||
To make this possible, we have introduced a lot more color variables you can use in [your color variants]({{%relref "basics/customization/#theme-variant" %}}). Your old variants will still work and don't need to be changed as apropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.
|
||||
To make this possible, we have introduced a lot more color variables you can use in [your color variants]({{%relref "basics/customization/#theme-variant" %}}). Your old variants will still work and don't need to be changed as appropriate fallback values are used by the theme. Nevertheless, the new colors allow for much more customization.
|
||||
|
||||
To see what's now possible, see the new variants `relearn-dark` and `neon` that are coming with this release.
|
||||
|
||||
|
|
@ -183,9 +183,9 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
## 2.9.0
|
||||
|
||||
- **Breaking**: This release removes the themes implementation of `ref`/`relref` in favor for Hugos standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard complient and exchanging this theme in your project to some other theme will be effortless.
|
||||
- **Breaking**: This release removes the themes implementation of `ref`/`relref` in favor for Hugos standard implementation. This is because of inconsistencies with the themes implementation. In advantage, your project becomes standard compliant and exchanging this theme in your project to some other theme will be effortless.
|
||||
|
||||
In a standard complient form you must not link to the `*.md` file but to its logical name. You'll see, referencing other pages becomes much easier. All three types result in the same reference:
|
||||
In a standard compliant form you must not link to the `*.md` file but to its logical name. You'll see, referencing other pages becomes much easier. All three types result in the same reference:
|
||||
|
||||
| Type | Non-Standard | Standard |
|
||||
| ------------- | -------------------------------- | ---------------------- |
|
||||
|
|
@ -197,7 +197,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
Also, the old themes implementation allowed refs to non-existing content. This will cause Hugos implementation to show the error below and abort the generation. If your project relies on this old behavior, you can [reconfigure the error handling](https://gohugo.io/content-management/cross-references/#link-to-another-language-version) of Hugos implementation.
|
||||
|
||||
In the best case your usage of the old implementation is already standard complient and you don't need to change anything. You'll notice this very easily once you've started `hugo server` after an upgrade and no errors are written to the console.
|
||||
In the best case your usage of the old implementation is already standard compliant and you don't need to change anything. You'll notice this very easily once you've started `hugo server` after an upgrade and no errors are written to the console.
|
||||
|
||||
You may see errors on the console after the update in the form:
|
||||
|
||||
|
|
@ -221,7 +221,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
## 2.8.0
|
||||
|
||||
- **Change**: Although never officially documented, this release removes the font `Novacento`/`Novecento`. If you use it in an overwritten CSS please replace it with `Work Sans`. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for czech.
|
||||
- **Change**: Although never officially documented, this release removes the font `Novacento`/`Novecento`. If you use it in an overwritten CSS please replace it with `Work Sans`. This change was necessary as Novacento did not provide all Latin special characters and lead to mixed styled character text eg. for Czech.
|
||||
|
||||
- **New**: The theme now supports favicons served from `static/images/` named as `favicon` or `logo` in SVG, PNG or ICO format [out of the box]({{% relref "basics/customization/#change-the-favicon" %}}). An overridden partial `layouts/partials/favicon.html` may not be necessary anymore in most cases.
|
||||
|
||||
|
|
@ -243,7 +243,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
## 2.5.0
|
||||
|
||||
- **Change**: New colors `--CODE-BLOCK-color` and `--CODE-BLOCK-BG-color` were added to provide a fallback for Hugos syntax highlightning in case `guessSyntax=true` is set. Ideally the colors are set to the same values as the ones from your chosen chroma style.
|
||||
- **Change**: New colors `--CODE-BLOCK-color` and `--CODE-BLOCK-BG-color` were added to provide a fallback for Hugos syntax highlighting in case `guessSyntax=true` is set. Ideally the colors are set to the same values as the ones from your chosen chroma style.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -263,7 +263,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
## 2.3.0
|
||||
|
||||
- **New**: Showcase multilanguage features by provding a documentation translation "fer us pirrrates". There will be no other translations besides the original English one and the Pirates one due to maintenance constraints.
|
||||
- **New**: Showcase multilanguage features by providing a documentation translation "fer us pirrrates". There will be no other translations besides the original English one and the Pirates one due to maintenance constraints.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -275,7 +275,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
## 2.1.0
|
||||
|
||||
- **Change**: In case the site's structure contains addional *.md files not part of the site (eg files that are meant to be included by site pages - see `CHANGELOG.md` in the exampleSite), they will now be ignored by the search.
|
||||
- **Change**: In case the site's structure contains additional *.md files not part of the site (eg files that are meant to be included by site pages - see `CHANGELOG.md` in the exampleSite), they will now be ignored by the search.
|
||||
|
||||
- **New**: Hidden pages are indexed for the site search by default. You can now turn off this behavior by setting `disableSearchHiddenPages=true` in your `config.toml`.
|
||||
|
||||
|
|
@ -287,7 +287,7 @@ This document shows you what's new in the latest release. For a detailed list of
|
|||
|
||||
## 2.0.0
|
||||
|
||||
- **Change**: Syntaxhighlightning was switched to the [built in Hugo mechanism](https://gohugo.io/content-management/syntax-highlighting/). You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation
|
||||
- **Change**: Syntax highlighting was switched to the [built in Hugo mechanism](https://gohugo.io/content-management/syntax-highlighting/). You may need to configure a new stylesheet or decide to roll you own as described on in the Hugo documentation
|
||||
|
||||
- **Change**: In the predefined stylesheets there was a typo and `--MENU-HOME-LINK-HOVERED-color` must be changed to `--MENU-HOME-LINK-HOVER-color`. You don't need to change anything in your custom color stylesheet as the old name will be used as a fallback.
|
||||
|
||||
|
|
|
|||
|
|
@ -87,9 +87,9 @@ weight = X
|
|||
Lorem Ipsum.
|
||||
```
|
||||
|
||||
Replace the `X` with a number or delete the whole `weight` parameter entirly.
|
||||
Replace the `X` with a number or delete the whole `weight` parameter entirely.
|
||||
|
||||
## Selfdefined Archetypes
|
||||
## Self defined Archetypes
|
||||
|
||||
If you are in need of further archetypes you can define your own or even redefine existing ones.
|
||||
|
||||
|
|
@ -103,7 +103,7 @@ archetype = "<kind>"
|
|||
+++
|
||||
````
|
||||
|
||||
Afterwards you can generate new content files of that kind with the follwing command
|
||||
Afterwards you can generate new content files of that kind with the following command
|
||||
|
||||
```shell
|
||||
hugo new --kind <kind> <name>/_index.md
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ The Relearn theme is fully compatible with Hugo multilingual mode.
|
|||
|
||||
It provides:
|
||||
|
||||
- Translation strings for default values (English, Piratized English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese). Feel free to contribute!
|
||||
- Translation strings for default values (English, Piratized English, Arabic, Simplified Chinese, Traditional Chinese, Dutch, French, German, Hindi, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese). Feel free to contribute!
|
||||
- Automatic menu generation from multilingual content
|
||||
- In-browser language switching
|
||||
|
||||
|
|
@ -67,7 +67,7 @@ You'll see error reports in your browsers console log for each unsupported langu
|
|||
|
||||
### Search with mixed language support
|
||||
|
||||
In case your page's content contains text in multiple languages (e.g. you are writing a russian documentation for your english API), you can add those languages to your `config.toml` to broaden search.
|
||||
In case your page's content contains text in multiple languages (e.g. you are writing a Russian documentation for your english API), you can add those languages to your `config.toml` to broaden search.
|
||||
|
||||
```toml
|
||||
[params]
|
||||
|
|
@ -77,7 +77,7 @@ In case your page's content contains text in multiple languages (e.g. you are wr
|
|||
As this is an array, you can add multiple additional languages.
|
||||
|
||||
{{% notice note %}}
|
||||
Keep in mind that the language code required here, is the base language code. E.g. if you have additonal content in `zh-CN`, you have to add just `zh` to this parameter.
|
||||
Keep in mind that the language code required here, is the base language code. E.g. if you have additional content in `zh-CN`, you have to add just `zh` to this parameter.
|
||||
{{% /notice %}}
|
||||
|
||||
## Overwrite translation strings
|
||||
|
|
@ -94,6 +94,6 @@ Just set `disableLanguageSwitchingButton=true` in your `config.toml`
|
|||
|
||||
```toml
|
||||
[params]
|
||||
# When using mulitlingual website, disable the switch language button.
|
||||
# When using multilingual website, disable the switch language button.
|
||||
disableLanguageSwitchingButton = true
|
||||
```
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ weight = 40
|
|||
````
|
||||
|
||||
By default, shortcuts are preceded by a title. This title can be disabled by setting `disableShortcutsTitle=true`.
|
||||
However, if you want to keep the title but change its value, it can be overriden by changing your local i18n translation string configuration.
|
||||
However, if you want to keep the title but change its value, it can be overridden by changing your local i18n translation string configuration.
|
||||
|
||||
For example, in your local `i18n/en.toml` file, add the following content
|
||||
|
||||
|
|
|
|||
|
|
@ -137,7 +137,7 @@ The theme generates the menu based on the following rules:
|
|||
- immediate children entries of the active page are shown regardless of any settings
|
||||
- if not overridden, all other first level entries behave like they would have been given `alwaysopen=false`
|
||||
- if not overridden, all other entries of levels besides the first behave like they would have been given `alwaysopen=true`
|
||||
- all visible entries show their immediate children entries if `alwaysopen=true`; this proceeds recursivley
|
||||
- all visible entries show their immediate children entries if `alwaysopen=true`; this proceeds recursively
|
||||
- all remaining entries are not shown
|
||||
|
||||
You can see this feature in action on the example page for [children shortcode]({{< relref "shortcodes/children" >}}) and its children pages.
|
||||
|
|
|
|||
|
|
@ -28,6 +28,6 @@ Many thanks to [Andy Miller](https://github.com/rhukster) for initially creating
|
|||
|
||||
## Tooling
|
||||
|
||||
- [GitHub](https://github.com) - Continuous deployement, testing and hosting of this project's sources and its documentation
|
||||
- [GitHub](https://github.com) - Continuous deployment, testing and hosting of this project's sources and its documentation
|
||||
- [gren](https://github.com/github-tools/github-release-notes) - A releasenotes generator for GitHub
|
||||
- [Hugo](https://gohugo.io/) - The static site generator of your choice
|
||||
|
|
|
|||
|
|
@ -10,4 +10,4 @@ You can add standard markdown syntax:
|
|||
...and even source code
|
||||
```
|
||||
|
||||
> the possiblities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)
|
||||
> the possibilities are endless (almost - including other shortcodes may or may not work) (almost - including other shortcodes may or may not work)
|
||||
|
|
|
|||
|
|
@ -31,11 +31,11 @@ While the examples are using shortcodes with named parameter you are free to als
|
|||
{{% /tab %}}
|
||||
{{< /tabs >}}
|
||||
|
||||
The shortcurt lists files found in a specific folder.
|
||||
The shortcode lists files found in a specific folder.
|
||||
|
||||
Currently, it supports two implementations for pages
|
||||
|
||||
1. If your page is a Markdown file, attachements must be placed in a folder named like your page and ending with `.files`.
|
||||
1. If your page is a Markdown file, attachments must be placed in a folder named like your page and ending with `.files`.
|
||||
|
||||
> * content
|
||||
> * _index.md
|
||||
|
|
@ -43,7 +43,7 @@ Currently, it supports two implementations for pages
|
|||
> * attachment.pdf
|
||||
> * page.md
|
||||
|
||||
2. If your page is a folder, attachements must be placed in a nested `files` folder.
|
||||
2. If your page is a folder, attachments must be placed in a nested `files` folder.
|
||||
|
||||
> * content
|
||||
> * _index.md
|
||||
|
|
@ -60,7 +60,7 @@ Be aware that if you use a multilingual website, you will need to have as many f
|
|||
| Name | Default | Notes |
|
||||
|:------------|:--------------|:------------|
|
||||
| **style** | `transparent` | The color scheme used to highlight the box content.<br><br>- by severity: `info`, `note`, `tip`, `warning`<nd color: `primary`, `secondary`<br>- by color: `blue`, `green`, `grey`, `orange`, `red`<br>- by special color: `default`,t` |
|
||||
| **title** | see notes | Arbitray text for the box title. Depending on the **style** there may be a default title. Any given value will overwault.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: `Attachments`<br><br>If you wa you have to set this parameter to `" "` (a non empty string filled with spaces) |
|
||||
| **title** | see notes | Arbitrary text for the box title. Depending on the **style** there may be a default title. Any given value will overwault.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: `Attachments`<br><br>If you wa you have to set this parameter to `" "` (a non empty string filled with spaces) |
|
||||
| **icon** | see notes | [Font Awesome icon name]({{%relref "cont/icons#finding-an-icon" %}}) set to the left of the title. Depending le** there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching iseverity<br>- for all other colors: `paperclip`<br><br>If you want no icon, you have to set this parameter to `" "` (a non empty d with spaces) |
|
||||
| **sort** | `asc` | Sorting the output in `asc`ending or `desc`ending order. |
|
||||
| **pattern** | `.*` | A [regular expressions](https://en.wikipedia.org/wiki/Regular_expression), used to filter the attachments by file name. For example:<br><br>- to match a file suffix of 'jpg', use `.*jpg` (not `*.jpg`)<br>- to match file names ending in `jpg` or `png`, use `.*(jpg\|png)` |
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ Once the button is clicked, it opens another browser tab for the given URL.
|
|||
| **style** | `transparent` | The color scheme used to paint the button.<br><br>- by severity: `info`, `note`, `tip`, `warning`<br>- by brand color: `primary`, `secondary`<br>- by color: `blue`, `green`, `grey`, `orange`, `red`<br>- by special color: `default`, `transparent` |
|
||||
| **icon** | see notes | [Font Awesome icon name]({{%relref "cont/icons#finding-an-icon" %}}) set to the left of the title. Depending on the **style** there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other colors: _<empty>_<br><br>If you want no icon for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |
|
||||
| **iconposition** | `left` | Places the icon to the `left` or `right` of the title. |
|
||||
| _**<content>**_ | see notes | Arbitray text for the button title. Depending on the **style** there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: _<empty>_<br><br>If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |
|
||||
| _**<content>**_ | see notes | Arbitrary text for the button title. Depending on the **style** there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: _<empty>_<br><br>If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ While the examples are using shortcodes with named parameter you are free to als
|
|||
|:-------------------|:------------------|:------------|
|
||||
| **containerstyle** | `ul` | Choose the style used to group all children. It could be any HTML tag name. |
|
||||
| **style** | `li` | Choose the style used to display each descendant. It could be any HTML tag name. |
|
||||
| **showhidden** | `false` | When `true`, child pages hidden from the menu will be displayed aswell. |
|
||||
| **showhidden** | `false` | When `true`, child pages hidden from the menu will be displayed as well. |
|
||||
| **description** | `false` | When `true` shows a short text under each page in the list. When no description or summary exists for the page, the first 70 words of the content is taken - [read more info about summaries on gohugo.io](https://gohugo.io/content/summaries/). |
|
||||
| **depth** | `1` | The depth of descendants to display. For example, if the value is `2`, the shortcode will display two levels of child pages. To get all descendants, set this value to a high number eg. `999`. |
|
||||
| **sort** | see notes | The sort order of the displayed list.<br><br>If not set it is sorted by the [`ordersectionsby`]({{% relref "basics/configuration#global-site-parameters" %}}) setting of the site and the pages frontmatter<br><br>- `weight`: to sort on menu order<br>- `title`: to sort alphabetically on menu label. |
|
||||
|
|
@ -60,7 +60,7 @@ While the examples are using shortcodes with named parameter you are free to als
|
|||
|
||||
{{%children description="true" %}}
|
||||
|
||||
### Infinte Depth and Hidden Pages
|
||||
### Infinite Depth and Hidden Pages
|
||||
|
||||
````go
|
||||
{{%/* children depth="999" showhidden="true" */%}}
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ The `expand` shortcode displays an expandable/collapsible section of text.
|
|||
|
||||
## Usage
|
||||
|
||||
While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials.
|
||||
While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.
|
||||
|
||||
{{< tabs groupId="shortcode-parameter">}}
|
||||
{{% tab name="shortcode" %}}
|
||||
|
|
@ -43,9 +43,9 @@ While the examples are using shortcodes with named parameter you are free to use
|
|||
|
||||
| Name | Position | Default | Notes |
|
||||
|:----------------------|:---------|:-----------------|:------------|
|
||||
| **title** | 1 | `"Expand me..."` | Arbitray text to appear next to the expand/collapse icon. |
|
||||
| **title** | 1 | `"Expand me..."` | Arbitrary text to appear next to the expand/collapse icon. |
|
||||
| **open** | 2 | `false` | When `true` the content text will be initially shown as expanded. |
|
||||
| _**<content>**_ | | _<empty>_ | Arbitray text to be displayed on expand. |
|
||||
| _**<content>**_ | | _<empty>_ | Arbitrary text to be displayed on expand. |
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -81,7 +81,7 @@ You can add standard markdown syntax:
|
|||
...and even source code
|
||||
```
|
||||
|
||||
> the possiblities are endless (almost - including other shortcodes may or may not work)
|
||||
> the possibilities are endless (almost - including other shortcodes may or may not work)
|
||||
{{%/* /expand */%}}
|
||||
````
|
||||
|
||||
|
|
@ -98,5 +98,5 @@ You can add standard markdown syntax:
|
|||
...and even source code
|
||||
```
|
||||
|
||||
> the possiblities are endless (almost - including other shortcodes may or may not work)
|
||||
> the possibilities are endless (almost - including other shortcodes may or may not work)
|
||||
{{% /expand %}}
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ The included files can even contain Markdown and will be taken into account when
|
|||
|
||||
## Examples
|
||||
|
||||
### Arbitray Content
|
||||
### Arbitrary Content
|
||||
|
||||
````go
|
||||
{{%/* include "shortcodes/INCLUDE_ME.md" */%}}
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ It is all about the boxes.
|
|||
|
||||
## Usage
|
||||
|
||||
While the examples are using shortcodes with named parameter you are free to use positional aswell or also call this shortcode from your own partials.
|
||||
While the examples are using shortcodes with named parameter you are free to use positional as well or also call this shortcode from your own partials.
|
||||
|
||||
{{< tabs groupId="shortcode-parameter">}}
|
||||
{{% tab name="shortcode" %}}
|
||||
|
|
@ -52,9 +52,9 @@ It is all about the boxes.
|
|||
| Name | Position | Default | Notes |
|
||||
|:----------|:---------|:----------|:------------|
|
||||
| **style** | 1 | `default` | The color scheme used to highlight the box content.<br><br>- by severity: `info`, `note`, `tip`, `warning`<br>- by brand color: `primary`, `secondary`<br>- by color: `blue`, `green`, `grey`, `orange`, `red`<br>- by special color: `default`, `transparent` |
|
||||
| **title** | 2 | see notes | Arbitray text for the box title. Depending on the **style** there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: _<empty>_<br><br>If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |
|
||||
| **title** | 2 | see notes | Arbitrary text for the box title. Depending on the **style** there may be a default title. Any given value will overwrite the default.<br><br>- for severity styles: the matching title for the severity<br>- for all other colors: _<empty>_<br><br>If you want no title for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |
|
||||
| **icon** | 3 | see notes | [Font Awesome icon name]({{%relref "cont/icons#finding-an-icon" %}}) set to the left of the title. Depending on the **style** there may be a default icon. Any given value will overwrite the default.<br><br>- for severity styles: a nice matching icon for the severity<br>- for all other colors: _<empty>_<br><br>If you want no icon for a severity style, you have to set this parameter to `" "` (a non empty string filled with spaces) |
|
||||
| _**<content>**_ | | _<empty>_ | Arbitray text to be displayed in box. |
|
||||
| _**<content>**_ | | _<empty>_ | Arbitrary text to be displayed in box. |
|
||||
|
||||
## Examples
|
||||
|
||||
|
|
@ -78,7 +78,7 @@ You can add standard markdown syntax:
|
|||
...and even source code
|
||||
```
|
||||
|
||||
> the possiblities are endless (almost - including other shortcodes may or may not work)
|
||||
> the possibilities are endless (almost - including other shortcodes may or may not work)
|
||||
{{%/* /notice */%}}
|
||||
````
|
||||
|
||||
|
|
@ -97,7 +97,7 @@ You can add standard markdown syntax:
|
|||
...and even source code
|
||||
```
|
||||
|
||||
> the possiblities are endless (almost - including other shortcodes may or may not work)
|
||||
> the possibilities are endless (almost - including other shortcodes may or may not work)
|
||||
{{% /notice %}}
|
||||
|
||||
#### Note
|
||||
|
|
|
|||
|
|
@ -5,6 +5,6 @@ title = "Tests"
|
|||
weight = 4
|
||||
+++
|
||||
|
||||
Some pages for internal testing of differnt styles
|
||||
Some pages for internal testing of different styles
|
||||
|
||||
{{%children containerstyle="div" style="h2" description="true" %}}
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
+++
|
||||
description = "Some testing for different styles used in syntax highlightning and preformatted blocks"
|
||||
description = "Some testing for different styles used in syntax highlighting and preformatted blocks"
|
||||
title = "Code"
|
||||
+++
|
||||
|
||||
Some testing for different styles used in syntax highlightning and preformatted blocks.
|
||||
Some testing for different styles used in syntax highlighting and preformatted blocks.
|
||||
|
||||
## Inline Code
|
||||
|
||||
|
|
@ -38,13 +38,13 @@ Code fences without any selected language
|
|||
|
||||
````jsonxmylmsl
|
||||
{
|
||||
"well": "Code fences with unexisting language"
|
||||
"well": "Code fences with non existing language"
|
||||
}
|
||||
````
|
||||
|
||||
## Block Preformatted
|
||||
|
||||
Some preformatted stuff with markdown indention
|
||||
Some preformatted stuff with markdown indentation
|
||||
|
||||
<pre>
|
||||
Some preformatted stuff in HTML elements
|
||||
|
|
|
|||
Loading…
Reference in a new issue