mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 02:33:18 +00:00
docs: announce all features
This commit is contained in:
Sören Weber
parent
e8ef4a5157
commit
ac86567cb1
3 changed files with 53 additions and 26 deletions
12
README.md
12
README.md
|
|
@ -11,15 +11,21 @@ The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo
|
|||
## Main features
|
||||
|
||||
- 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
|
||||
- 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
|
||||
- Unlimited menu levels
|
||||
- Automatic next/prev buttons to navigate through menu entries
|
||||
- Unrestricted menu configuration relating to amount of items and level of nesting
|
||||
- Font Awesome icons
|
||||
- Tagging support
|
||||
- Image resizing, shadow…
|
||||
- Syntax highlighting
|
||||
- Attachments files
|
||||
- List child pages
|
||||
- Mermaid diagram (flowchart, sequence, gantt)
|
||||
- Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.
|
||||
- Swagger UI for OpenAPI Specifications
|
||||
- Customizable look and feel
|
||||
- Predefined (light, dark) and customizable color variants
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
{{% /notice %}}
|
||||
|
||||
* Usable offline, no external dependencies
|
||||
* [Automatic Search]({{%relref "basics/configuration#activate-search" %}})
|
||||
* [Print]({{%relref "basics/configuration#activate-print-support" %}}) whole chapters or even the complete site
|
||||
* [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
|
||||
* Unlimited menu levels
|
||||
* Automatic next/prev buttons to navigate through menu entries
|
||||
* [Image resizing, shadow...]({{%relref "cont/markdown#images" %}})
|
||||
* [Attachments files]({{%relref "shortcodes/attachments" %}})
|
||||
* [List child pages]({{%relref "shortcodes/children" %}})
|
||||
* [Mermaid diagram]({{%relref "shortcodes/mermaid" %}}) (flowchart, sequence, gantt)
|
||||
* [Swagger UI]({{%relref "shortcodes/swagger" %}}) for OpenAPI Specifications
|
||||
* [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" %}})
|
||||
- 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]({{%relref "basics/configuration#activate-search" %}})
|
||||
- [Print]({{%relref "basics/configuration#activate-print-support" %}}) whole chapters or even the complete site
|
||||
- [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
|
||||
- [Unrestricted menu configuration]({{%relref "cont/menushortcuts" %}}) relating to amount of items and level of nesting
|
||||
- [Font Awesome icons]({{%relref "cont/icons" %}})
|
||||
- [Tagging support]({{%relref "cont/tags" %}})
|
||||
- [Image resizing, shadow...]({{%relref "cont/markdown#images" %}})
|
||||
- [Syntax highlighting]({{%relref "cont/syntaxhighlight" %}})
|
||||
- [Attachments files]({{%relref "shortcodes/attachments" %}})
|
||||
- [List child pages]({{%relref "shortcodes/children" %}})
|
||||
- [Mermaid diagrams]({{%relref "shortcodes/mermaid" %}}) for flowcharts, sequences, gantts, pie, etc.
|
||||
- [Swagger UI]({{%relref "shortcodes/swagger" %}}) for OpenAPI Specifications
|
||||
- [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
|
||||
|
||||
|
|
|
|||
25
theme.toml
25
theme.toml
|
|
@ -4,8 +4,23 @@ licenselink = "https://github.com/McShelby/hugo-theme-relearn/blob/main/LICENSE"
|
|||
description = "A theme for Hugo designed for documentation"
|
||||
homepage = "https://github.com/McShelby/hugo-theme-relearn"
|
||||
demosite = "https://mcshelby.github.io/hugo-theme-relearn"
|
||||
tags = ["dark", "dark mode", "docs", "light", "multilingual", "responsive"]
|
||||
features = ["dark mode", "documentation", "expand", "include", "light mode", "menu", "mermaid", "multilingual", "nested sections", "notice", "oas", "search", "swagger", "tabs", "themeable"]
|
||||
tags = ["dark", "docs", "light", "multilingual", "responsive"]
|
||||
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.hugoVersion]
|
||||
|
|
@ -16,6 +31,6 @@ features = ["dark mode", "documentation", "expand", "include", "light mode", "me
|
|||
homepage = "https://github.com/McShelby"
|
||||
|
||||
[original]
|
||||
author = "Mathieu Cornic"
|
||||
homepage = "https://learn.netlify.app"
|
||||
repo = "https://github.com/matcornic/hugo-theme-learn"
|
||||
author = "Mathieu Cornic"
|
||||
homepage = "https://learn.netlify.app"
|
||||
repo = "https://github.com/matcornic/hugo-theme-learn"
|
||||
|
|
|
|||
Loading…
Reference in a new issue