Skip to content

Commit

Permalink
docs: use portable linking #377
Browse files Browse the repository at this point in the history
  • Loading branch information
McShelby committed Oct 24, 2023
1 parent c836962 commit d2583cf
Show file tree
Hide file tree
Showing 24 changed files with 155 additions and 155 deletions.
74 changes: 37 additions & 37 deletions exampleSite/content/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title = "Hugo Relearn Theme"

A theme for [Hugo](https://gohugo.io/) designed for documentation.

[★ What's new in the latest release ★]({{% relref "basics/migration" %}})
[★ What's new in the latest release ★](basics/migration)

![Image of the Relearn theme in light and dark mode on phone, tablet and desktop](images/hero.png?width=100%&height=100%)

Expand All @@ -19,50 +19,50 @@ The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo
- Responsive design for mobile usage
- Looks nice on paper (if it has to)
- Usable offline, no external dependencies
- [Usable from your local file system via `file://` protocol]({{%relref "basics/configuration#serving-your-page-from-the-filesystem" %}})
- [Usable from your local file system via `file://` protocol](basics/configuration#serving-your-page-from-the-filesystem)
- Support for the [VSCode Front Matter extension](https://github.com/estruyf/vscode-front-matter) for on-premise CMS capabilities
- Support for Internet Explorer 11
- [Support for Open Graph and Twitter Cards]({{% relref "basics/configuration/#social-media-meta-tags" %}})
- [Support for Open Graph and Twitter Cards](basics/configuration/#social-media-meta-tags)
- **Configurable theming and visuals**
- [Configurable brand images]({{%relref "basics/customization#change-the-logo" %}})
- [Automatic switch for light/dark variant dependend on your OS settings]({{%relref "basics/customization#adjusting-to-os-settings" %}})
- [Configurable brand images](basics/customization#change-the-logo)
- [Automatic switch for light/dark variant dependend on your OS settings](basics/customization#adjusting-to-os-settings)
- Predefined light, dark and color variants
- [User selectable variants]({{%relref "basics/customization#multiple-variants" %}})
- [Stylesheet generator]({{%relref "basics/generator" %}})
- [Configurable syntax highlighting]({{%relref "shortcodes/highlight" %}})
- [User selectable variants](basics/customization#multiple-variants)
- [Stylesheet generator](basics/generator/)
- [Configurable syntax highlighting](shortcodes/highlight)
- **Unique theme features**
- [Print whole chapters or even the complete site]({{%relref "basics/configuration#activate-print-support" %}})
- [Print whole chapters or even the complete site](basics/configuration#activate-print-support)
- In page search
- [Site search]({{%relref "basics/configuration#activate-search" %}})
- [Dedicated search page]({{%relref "basics/configuration#activate-dedicated-search-page" %}})
- [Taxonomy support]({{%relref "cont/taxonomy" %}})
- [Configurable topbar buttons]({{%relref "basics/topbar" %}})
- [Unlimited nested menu items]({{%relref "cont/pages" %}})
- [Configurable shortcut links]({{%relref "cont/menushortcuts" %}})
- [Site search](basics/configuration#activate-search)
- [Dedicated search page](basics/configuration#activate-dedicated-search-page)
- [Taxonomy support](cont/taxonomy)
- [Configurable topbar buttons](basics/topbar)
- [Unlimited nested menu items](cont/pages)
- [Configurable shortcut links](cont/menushortcuts)
- Hidden pages
- **Multi language support**
- [Full support for languages written right to left]({{%relref "cont/i18n" %}})
- [Available languages]({{%relref "cont/i18n#basic-configuration" %}}): Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese
- [Search support for mixed language content]({{%relref "cont/i18n#search" %}})
- [Full support for languages written right to left](cont/i18n)
- [Available languages](cont/i18n#basic-configuration): Arabic, Simplified Chinese, Traditional Chinese, Czech, Dutch, English, Finnish, French, German, Hindi, Hungarian, Indonesian, Italian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Swahili, Turkish, Vietnamese
- [Search support for mixed language content](cont/i18n#search)
- **Additional Markdown features**
- [Support for GFM (GitHub Flavored Markdown]({{%relref "cont/markdown" %}})
- [Image effects like sizing, shadow, border and alignment]({{%relref "cont/markdown#image-effects" %}})
- [Image lightbox]({{%relref "cont/markdown#lightbox" %}})
- [Support for GFM (GitHub Flavored Markdown](cont/markdown)
- [Image effects like sizing, shadow, border and alignment](cont/markdown#image-effects)
- [Image lightbox](cont/markdown#lightbox)
- **Shortcodes galore**
- [Display files attached to page bundles]({{%relref "shortcodes/attachments" %}})
- [Marker badges]({{%relref "shortcodes/badge" %}})
- [Configurable buttons]({{%relref "shortcodes/button" %}})
- [List child pages]({{%relref "shortcodes/children" %}})
- [Expand areas to reveal content]({{%relref "shortcodes/expand" %}})
- [Font Awesome icons]({{%relref "shortcodes/icon" %}})
- [Inclusion of other files]({{%relref "shortcodes/include" %}})
- [Math and chemical formulae using MathJax]({{%relref "shortcodes/math" %}})
- [Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.]({{%relref "shortcodes/mermaid" %}})
- [Colorful boxes]({{%relref "shortcodes/notice" %}})
- [OpenAPI specifications using Swagger UI]({{%relref "shortcodes/openapi" %}})
- [Reveal you site's configuration parameter]({{%relref "shortcodes/siteparam" %}})
- [Tabbed panels]({{%relref "shortcodes/tabs" %}})
- [Single tabbed panels]({{%relref "shortcodes/tab" %}}) and [multiple tabbed panels]({{%relref "shortcodes/tabs" %}})
- [Display files attached to page bundles](shortcodes/attachments)
- [Marker badges](shortcodes/badge)
- [Configurable buttons](shortcodes/button)
- [List child pages](shortcodes/children)
- [Expand areas to reveal content](shortcodes/expand)
- [Font Awesome icons](shortcodes/icon)
- [Inclusion of other files](shortcodes/include)
- [Math and chemical formulae using MathJax](shortcodes/math)
- [Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.](shortcodes/mermaid)
- [Colorful boxes](shortcodes/notice)
- [OpenAPI specifications using Swagger UI](shortcodes/openapi)
- [Reveal you site's configuration parameter](shortcodes/siteparam)
- [Tabbed panels](shortcodes/tabs)
- [Single tabbed panels](shortcodes/tab) and [multiple tabbed panels](shortcodes/tabs)

## Support

Expand All @@ -72,12 +72,12 @@ To get support, feel free to open a new [discussion topic](https://github.com/Mc

Feel free to contribute to this documentation by just clicking the {{% button style="transparent" icon="pen" %}}{{% /button %}} _edit_ button displayed on top right of each page.

You are most welcome to contribute bugfixes or new features by making pull requests to the [official repository](https://github.com/McShelby/hugo-theme-relearn). Check the [contribution guidelines]({{%relref "dev/contributing" %}}) first before starting.
You are most welcome to contribute bugfixes or new features by making pull requests to the [official repository](https://github.com/McShelby/hugo-theme-relearn). Check the [contribution guidelines](dev/contributing) first before starting.

## License

The Relearn theme is licensed under the [MIT License](https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE).

## Credits

This theme would not be possible without the work of [many others]({{%relref "more/credits" %}}).
This theme would not be possible without the work of [many others](more/credits).
4 changes: 2 additions & 2 deletions exampleSite/content/basics/configuration/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ Nevertheless, if you're unhappy with the resulting URLs you can manually redefin

## MathJax

The MathJax configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See [Math]({{% relref "shortcodes/math" %}}) for additional documentation.
The MathJax configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See [Math](shortcodes/math) for additional documentation.

### Example {#math-example}

Expand All @@ -194,7 +194,7 @@ You also can disable MathJax for specific pages while globally enabled.

## Mermaid

The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See [Mermaid]({{% relref "shortcodes/mermaid" %}}) for additional documentation.
The Mermaid configuration parameters can also be set on a specific page. In this case, the global parameter would be overwritten by the local one. See [Mermaid](shortcodes/mermaid) for additional documentation.

### Example {#mermaid-example}

Expand Down
2 changes: 1 addition & 1 deletion exampleSite/content/basics/customization/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ document.addEventListener( 'themeVariantLoaded', function( e ){

### Roll your Own

If you are not happy with the shipped variants you can either copy and rename one of the shipped files from `themes/hugo-theme-relearn/static/css` to `static/css`, edit them afterwards to your liking in a text editor and configure the `themeVariant` parameter in your `config.toml` or just use the [interactive variant generator]({{%relref "basics/generator" %}}).
If you are not happy with the shipped variants you can either copy and rename one of the shipped files from `themes/hugo-theme-relearn/static/css` to `static/css`, edit them afterwards to your liking in a text editor and configure the `themeVariant` parameter in your `config.toml` or just use the [interactive variant generator](basics/generator).

## Own Shortcodes with JavaScript Dependencies

Expand Down
Loading

0 comments on commit d2583cf

Please sign in to comment.