nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-11-23 15:57:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: some love for the intro and credits

Browse source
This commit is contained in:
Sören Weber 2022-12-14 22:46:59 +01:00
parent d2e2bbcf78
commit 816766c9b5
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
5 changed files with 21 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -8,7 +8,7 @@ A theme for [Hugo](https://gohugo.io/) designed for documentation.
The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo-theme-learn) with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.
## Main features
## Features
- Usable offline, no external dependencies
- Usable without a HTTP server from the file system
@ -25,21 +25,22 @@ The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo
- Unrestricted menu configuration relating to amount of items and level of nesting
- Font Awesome icons
- Tagging support
- Image resizing, shadow…
- Image styling like sizing, shadow, border and alignment
- Syntax highlighting
- Customizable look and feel
- Predefined (light, dark) and customizable color variants
- Attachments files
- List child pages
- Math and chemical formulae using the MathJax library
- Mermaid diagrams for flowcharts, sequences, gantts, pie, etc.
- Swagger UI for OpenAPI Specifications
- Customizable look and feel
- Predefined (light, dark) and customizable color variants
- Badges
- Buttons
- Tip/Note/Info/Warning boxes
- Expand
- Tabs
- File inclusion
## Installation
Visit the [installation instructions](https://mcshelby.github.io/hugo-theme-relearn/basics/installation) to learn how to setup the theme in your Hugo installation.
@ -50,11 +51,11 @@ Visit the [documentation](https://mcshelby.github.io/hugo-theme-relearn/) to lea
## Changelog
See the [changelog](https://mcshelby.github.io/hugo-theme-relearn/basics/history) for a complete list of releases.
See the [What's New](https://mcshelby.github.io/hugo-theme-relearn/basics/migration) page for release highlights or the [history](https://mcshelby.github.io/hugo-theme-relearn/basics/history) for a complete list of changes per release.
## Contribution
You are most welcome to contribute to the source code but please visit the [contribution guidelines](https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/contributing.md) first.
You are most welcome to contribute bugfixes or even new features to the source code. Please visit the [contribution guidelines](https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/contributing.md) first.
## License
@ -67,3 +68,5 @@ Special thanks to [everyone who has contributed](https://github.com/McShelby/hug
Many thanks to [Mathieu Cornic](https://github.com/matcornic) for his work on porting the [Learn theme](https://github.com/matcornic/hugo-theme-learn) to Hugo.
Many thanks to [Andy Miller](https://github.com/rhukster) for initially creating the [Learn theme](https://github.com/getgrav/grav-theme-learn2) for Grav.
See the [credits](https://mcshelby.github.io/hugo-theme-relearn/credits) for a detailed list.

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

@ -9,10 +9,10 @@ The [Relearn theme](http://github.com/McShelby/hugo-theme-relearn) is a theme fo
The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo-theme-learn) with the aim of fixing long outstanding bugs and adepting to latest Hugo features. As far as possible this theme tries to be a drop-in replacement for the Learn theme.
{{% /notice %}}
## Main features
## Features
{{% notice tip %}}
See [what's new]({{% relref "basics/migration" %}}) within the latest update.
See [What's New]({{% relref "basics/migration" %}}) within the latest update.
{{% /notice %}}
- Usable offline, no external dependencies
@ -30,15 +30,15 @@ See [what's new]({{% relref "basics/migration" %}}) within the latest update.
- [Unrestricted menu configuration]({{%relref "cont/menushortcuts" %}}) relating to amount of items and level of nesting
- [Font Awesome icons]({{%relref "shortcodes/icon" %}})
- [Tagging support]({{%relref "cont/tags" %}})
- [Image resizing, shadow...]({{%relref "cont/markdown#images" %}})
- [Image styling]({{%relref "cont/markdown#images" %}}) like sizing, shadow, border and alignment
- [Syntax highlighting]({{%relref "cont/syntaxhighlight" %}})
- [Customizable look and feel]({{%relref "basics/customization"%}})
- [Predefined (light, dark) and customizable color variants]({{%relref "basics/generator" %}})
- [Attachments files]({{%relref "shortcodes/attachments" %}})
- [List child pages]({{%relref "shortcodes/children" %}})
- [Math and chemical formulae]({{%relref "shortcodes/math" %}}) using the MathJax library
- [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" %}})
- [Badges]({{%relref "shortcodes/badge" %}})
- [Buttons]({{%relref "shortcodes/button" %}})
- [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice" %}})
@ -46,13 +46,13 @@ See [what's new]({{% relref "basics/migration" %}}) within the latest update.
- [Tabs]({{%relref "shortcodes/tabs" %}})
- [File inclusion]({{%relref "shortcodes/include" %}})
## Getting support
## Getting Support
To get support, feel free to open a new [discussion topic](https://github.com/McShelby/hugo-theme-relearn/discussions) or [issue](https://github.com/McShelby/hugo-theme-relearn/issues) in the official repository on GitHub.
To get support, feel free to open a new [discussion topic](https://github.com/McShelby/hugo-theme-relearn/discussions) or [issue report](https://github.com/McShelby/hugo-theme-relearn/issues) in the official repository on GitHub.
## Become a contributor
## Become a Contributor
Feel free to update this documentation by just clicking the **Edit** link displayed on top right of each page. Your changes will be deployed automatically once they were reviewed.
Feel free to update this documentation by just clicking the {{% button style="transparent" icon="pen" %}}{{% /button %}} button displayed on top right of each page. Your changes will be deployed automatically once they were reviewed.
You are most welcome to contribute bugfixes or even new features to the source code by making pull requests to the [official repository](https://github.com/McShelby/hugo-theme-relearn) via GitHub. Please visit the [contribution guidelines](https://github.com/McShelby/hugo-theme-relearn/blob/main/.github/contributing.md) first.

2
exampleSite/content/basics/migration/_index.en.md
View file

@ -1,6 +1,6 @@
+++
disableToc = false
title = "What's new"
title = "What's New"
weight = 2
+++

2
exampleSite/content/basics/migration/_index.pir.md
View file

@ -1,6 +1,6 @@
+++
disableToc = false
title = "What's new"
title = "What's New"
weight = 2
+++
{{< piratify >}}

2
exampleSite/content/more/credits/_index.en.md
View file

@ -11,7 +11,7 @@ Many thanks to [Mathieu Cornic](https://github.com/matcornic) for his work on po
Many thanks to [Andy Miller](https://github.com/rhukster) for initially creating the [Learn theme](https://github.com/getgrav/grav-theme-learn2) for Grav.
## Packages and libraries
## Packages and Libraries
- [autoComplete](https://github.com/Pixabay/JavaScript-autoComplete) - A lightweight and powerful vanilla JavaScript completion suggester
- [clipboard.js](https://clipboardjs.com) - A modern approach to copy text to clipboard