nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-27 09:43:06 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: announce all features

Browse source
This commit is contained in:
Sören Weber 2022-04-11 11:04:14 +02:00
parent e8ef4a5157
commit ac86567cb1
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
3 changed files with 53 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -11,15 +11,21 @@ The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo
## Main features ## Main features
- Usable offline, no external dependencies - Usable offline, no external dependencies
- Support for Internet Explorer 11
- Responsive design
- Configurable hidden pages
- Automatic next/prev buttons to navigate through menu entries
- Automatic Search - Automatic Search
- Print whole chapters or even the complete site - Print whole chapters or even the complete site
- Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese - Multilingual mode for English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
- Unlimited menu levels - Unrestricted menu configuration relating to amount of items and level of nesting
- Automatic next/prev buttons to navigate through menu entries - Font Awesome icons
- Tagging support
- Image resizing, shadow… - Image resizing, shadow…
- Syntax highlighting
- Attachments files - Attachments files
- List child pages - List child pages
- Mermaid diagram (flowchart, sequence, gantt) - Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.
- Swagger UI for OpenAPI Specifications - Swagger UI for OpenAPI Specifications
- Customizable look and feel - Customizable look and feel
- Predefined (light, dark) and customizable color variants - Predefined (light, dark) and customizable color variants

42
exampleSite/content/_index.en.md
View file

@ -16,24 +16,30 @@ The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo
See [what's new]({{% relref "basics/migration" %}}) within the latest update. See [what's new]({{% relref "basics/migration" %}}) within the latest update.
{{% /notice %}} {{% /notice %}}
* Usable offline, no external dependencies - Usable offline, no external dependencies
* [Automatic Search]({{%relref "basics/configuration#activate-search" %}}) - Support for Internet Explorer 11
* [Print]({{%relref "basics/configuration#activate-print-support" %}}) whole chapters or even the complete site - Responsive design
* [Multilingual mode]({{%relref "cont/i18n" %}}) for English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese - Configurable hidden pages
* Unlimited menu levels - Automatic next/prev buttons to navigate through menu entries
* Automatic next/prev buttons to navigate through menu entries - [Automatic Search]({{%relref "basics/configuration#activate-search" %}})
* [Image resizing, shadow...]({{%relref "cont/markdown#images" %}}) - [Print]({{%relref "basics/configuration#activate-print-support" %}}) whole chapters or even the complete site
* [Attachments files]({{%relref "shortcodes/attachments" %}}) - [Multilingual mode]({{%relref "cont/i18n" %}}) for English, Arabic, Simplified Chinese, Traditional Chinesse, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Polish, Portuguese, Russian, Spanish, Turkish, Vietnamese
* [List child pages]({{%relref "shortcodes/children" %}}) - [Unrestricted menu configuration]({{%relref "cont/menushortcuts" %}}) relating to amount of items and level of nesting
* [Mermaid diagram]({{%relref "shortcodes/mermaid" %}}) (flowchart, sequence, gantt) - [Font Awesome icons]({{%relref "cont/icons" %}})
* [Swagger UI]({{%relref "shortcodes/swagger" %}}) for OpenAPI Specifications - [Tagging support]({{%relref "cont/tags" %}})
* [Customizable look and feel]({{%relref "basics/customization"%}}) - [Image resizing, shadow...]({{%relref "cont/markdown#images" %}})
* [Predefined (light, dark) and customizable color variants]({{%relref "basics/generator" %}}) - [Syntax highlighting]({{%relref "cont/syntaxhighlight" %}})
* [Buttons]({{%relref "shortcodes/button" %}}) - [Attachments files]({{%relref "shortcodes/attachments" %}})
* [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice" %}}) - [List child pages]({{%relref "shortcodes/children" %}})
* [Expand]({{%relref "shortcodes/expand" %}}) - [Mermaid diagrams]({{%relref "shortcodes/mermaid" %}}) for flowcharts, sequences, gantts, pie, etc.
* [Tabs]({{%relref "shortcodes/tabs" %}}) - [Swagger UI]({{%relref "shortcodes/swagger" %}}) for OpenAPI Specifications
* [File inclusion]({{%relref "shortcodes/include" %}}) - [Customizable look and feel]({{%relref "basics/customization"%}})
- [Predefined (light, dark) and customizable color variants]({{%relref "basics/generator" %}})
- [Buttons]({{%relref "shortcodes/button" %}})
- [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice" %}})
- [Expand]({{%relref "shortcodes/expand" %}})
- [Tabs]({{%relref "shortcodes/tabs" %}})
- [File inclusion]({{%relref "shortcodes/include" %}})
## Getting support ## Getting support

25
theme.toml
View file

@ -4,8 +4,23 @@ licenselink = "https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE"
description = "A theme for Hugo designed for documentation" description = "A theme for Hugo designed for documentation"
homepage = "https://github.com/McShelby/hugo-theme-relearn" homepage = "https://github.com/McShelby/hugo-theme-relearn"
demosite = "https://mcshelby.github.io/hugo-theme-relearn" demosite = "https://mcshelby.github.io/hugo-theme-relearn"
tags = ["dark", "dark mode", "docs", "light", "multilingual", "responsive"] tags = ["dark", "docs", "light", "multilingual", "responsive"]
features = ["dark mode", "documentation", "expand", "include", "light mode", "menu", "mermaid", "multilingual", "nested sections", "notice", "oas", "search", "swagger", "tabs", "themeable"] features = ["breadcrumbs", "boxes", "buttons",
"customizable", "color variants",
"dark", "docs", "documentation",
"expand",
"favicon", "file inclusion", "font awesome",
"hidden pages",
"i18n", "ie11", "image resizing", "include", "internet explorer",
"light", "lightbox", "logo",
"menu", "mermaid", "multilingual", "mobile",
"nested sections", "notice",
"openapi specification", "oas", "offline usable",
"print", "printable",
"responsive", "rss",
"sidebar", "sitemap",
"search", "subtheme", "swagger", "swaggerui", "syntax highlighting",
"table of contents", "tabs", "tags", "themeable", "themes", "toc"]
[module] [module]
[module.hugoVersion] [module.hugoVersion]
@ -16,6 +31,6 @@ features = ["dark mode", "documentation", "expand", "include", "light mode", "me
homepage = "https://github.com/McShelby" homepage = "https://github.com/McShelby"
[original] [original]
author = "Mathieu Cornic" author = "Mathieu Cornic"
homepage = "https://learn.netlify.app" homepage = "https://learn.netlify.app"
repo = "https://github.com/matcornic/hugo-theme-learn" repo = "https://github.com/matcornic/hugo-theme-learn"