Skip to content

Commit

Permalink
User guide: fix invalid html by adding alt attribute to image
Browse files Browse the repository at this point in the history
Remove trailing whitespace in a few .md files
  • Loading branch information
deining authored and geriom committed Oct 21, 2022
1 parent cfa70e3 commit a2f7ecd
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion userguide/content/en/docs/Language/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ If you configure more than one language in `config.toml`, the Docsy theme adds a

## Internationalization bundles

All UI strings (text for buttons etc.) are bundled inside `/i18n` in the theme, with a `.toml` file for each language.
All UI strings (text for buttons etc.) are bundled inside `/i18n` in the theme, with a `.toml` file for each language.

If your chosen language isn't currently in the theme and you create your own `.toml` file for all the common UI strings (for example, if you translate the UI text into Japanese and create a copy of `en.toml` called `jp.toml`), we recommend you do this **in the theme** rather than in your own project, so it can be reused by others. Any additional strings or overridden values can be added to your project's `/i18n` folder.

Expand Down
4 changes: 2 additions & 2 deletions userguide/content/en/docs/adding-content/shortcodes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ The Docsy template provides two shortcodes `tabpane` and `tab` that let you easi
{{%/* /tab */%}}
{{</* tab header="German" lang="de" */>}}
<b>Herzlich willkommen!</b>
<img src="flags/de.png" style="float: right; padding: 0 0 0 0px">
<img src="flags/de.png" alt="Flag Germany" style="float: right; padding: 0 0 0 0px">
{{</* /tab */>}}
{{%/* tab header="Swahili" lang="sw" */%}}
![Flag Tanzania](flags/tz.png)
Expand All @@ -422,7 +422,7 @@ This code translates to the right aligned tabbed pane below, showing a `Welcome!
{{% /tab %}}
{{< tab header="German" lang="de" >}}
<b>Herzlich willkommen!</b>
<img src="flags/de.png" style="float: right; padding: 0 0 0 0px">
<img src="flags/de.png" alt="Flag Germany" style="float: right; padding: 0 0 0 0px">
{{< /tab >}}
{{% tab header="Swahili" lang="sw" %}}
![Flag Tanzania](flags/tz.png)
Expand Down
8 changes: 4 additions & 4 deletions userguide/content/en/docs/adding-content/taxonomy.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: >
Structure the content using taxonomies like tags, categories, labels.
---

Docsy supports Hugo's Taxonomies (see: https://gohugo.io/content-management/taxonomies/) in its docs and blog section. You can see the default layout and can test the behavior of the generated links on this page.
Docsy supports Hugo's Taxonomies (see: https://gohugo.io/content-management/taxonomies/) in its docs and blog section. You can see the default layout and can test the behavior of the generated links on this page.

## Terminology

Expand Down Expand Up @@ -125,11 +125,11 @@ params:
{{< /tab >}}
{{< /tabpane >}}

The settings above would only show a taxonomy cloud for `projects` and `tags` (with the headlines "Our Projects" and "Tag Cloud") in Docsy's right sidebar and the assigned terms for the taxonomies `tags` and `categories` for each page.
The settings above would only show a taxonomy cloud for `projects` and `tags` (with the headlines "Our Projects" and "Tag Cloud") in Docsy's right sidebar and the assigned terms for the taxonomies `tags` and `categories` for each page.

To disable any taxonomy cloud you have to set the Parameter `taxonomyCloud = []` resp. if you don't want to show the assigned terms you have to set `taxonomyPageHeader = []`.
To disable any taxonomy cloud you have to set the Parameter `taxonomyCloud = []` resp. if you don't want to show the assigned terms you have to set `taxonomyPageHeader = []`.

As default the plural label of a taxonomy is used as it cloud title. You can overwrite the default cloud title with `taxonomyCloudTitle`. But if you do so, you have to define a manual title for each enabled taxonomy cloud (`taxonomyCloud` and `taxonomyCloudTitle` must have the same length!).
As default the plural label of a taxonomy is used as it cloud title. You can overwrite the default cloud title with `taxonomyCloudTitle`. But if you do so, you have to define a manual title for each enabled taxonomy cloud (`taxonomyCloud` and `taxonomyCloudTitle` must have the same length!).

If you don't set the parameters `taxonomyCloud` resp. `taxonomyPageHeader` the taxonomy clouds resp. assigned terms for all defined taxonomies will be generated.
## Partials
Expand Down
14 changes: 7 additions & 7 deletions userguide/content/en/docs/adding-content/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ to display an information banner on the archived sites.

## Adding a version drop-down menu

If you add some `[params.versions]` in `config.toml`/`config.yaml`/`config.json`, the Docsy theme adds a
version selector drop down to the top-level menu. You specify a URL and a name
If you add some `[params.versions]` in `config.toml`/`config.yaml`/`config.json`, the Docsy theme adds a
version selector drop down to the top-level menu. You specify a URL and a name
for each version you would like to add to the menu, as in the following example:

{{< tabpane persistLang=false >}}
Expand Down Expand Up @@ -84,7 +84,7 @@ version_menu: 'Releases'
{{< /tab >}}
{{< /tabpane >}}

If you set the `version_menu_pagelinks` parameter to `true`, then links in the version drop-down menu
If you set the `version_menu_pagelinks` parameter to `true`, then links in the version drop-down menu
point to the current page in the other version, instead of the main page.
This can be useful if the document doesn't change much between the different versions.
Note that if the current page doesn't exist in the other version, the link will be broken.
Expand All @@ -94,12 +94,12 @@ You can read more about Docsy menus in the guide to

## Displaying a banner on archived doc sites

If you create archived snapshots for older versions of your docs, you can add a
If you create archived snapshots for older versions of your docs, you can add a
note at the top of every page in the archived docs to let readers know that
they’re seeing an unmaintained snapshot and give them a link to the latest
they’re seeing an unmaintained snapshot and give them a link to the latest
version.

For example, see the archived docs for
For example, see the archived docs for
[Kubeflow v0.6](https://v0-6.kubeflow.org/docs/):

<figure>
Expand Down Expand Up @@ -145,7 +145,7 @@ version: '0.1'
{{< /tabpane >}}

1. Make sure that `url_latest_version` contains the URL of the website that you
want to point readers to. In most cases, this should be the URL of the latest
want to point readers to. In most cases, this should be the URL of the latest
version of your docs:

{{< tabpane persistLang=false >}}
Expand Down

0 comments on commit a2f7ecd

Please sign in to comment.