docs: elaborate on fork decision #26

This commit is contained in:
Sören Weber 2021-08-28 10:39:54 +02:00
parent 3931faa1d5
commit 8a7dce6ce5
No known key found for this signature in database
GPG key ID: 07D17FF580AE7589
4 changed files with 24 additions and 17 deletions

View file

@ -1,14 +1,12 @@
# Hugo Relearn Theme
A documentation theme for [Hugo](https://gohugo.io/).
A theme for [Hugo](https://gohugo.io/) designed for documentation.
![Overview](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/screenshot.png)
## Motivation
The theme initially was a fork of [hugo-theme-learn](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 the theme tries to be a drop-in replacement for hugo-theme-learn. The documentation provides instructions on how to achieve the best compatiblity while still benefitting from bug fixes and new features.
The theme initially was a fork of the great[hugo-theme-learn](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 hugo-theme-learn.
## Main features
@ -20,8 +18,12 @@ As far as possible the theme tries to be a drop-in replacement for hugo-theme-le
- Attachments files
- List child pages
- Mermaid diagram (flowchart, sequence, gantt)
- Customizable look and feel and themes variants
- Buttons, Tip/Note/Info/Warning boxes, Expand, Tabs
- Customizable look and feel and theme variants
- Buttons
- Tip/Note/Info/Warning boxes
- Expand
- Tabs
- File inclusion
## Installation

View file

@ -4,38 +4,43 @@ title = "Relearn Theme for Hugo"
# Hugo Relearn Theme
[Hugo-theme-relearn](http://github.com/McShelby/hugo-theme-relearn) is a theme for [Hugo](https://gohugo.io/), a fast and modern static website engine written in Go. Where Hugo is often used for blogs, this multilingual-ready theme is **fully designed for documentation**.
[Hugo-theme-relearn](http://github.com/McShelby/hugo-theme-relearn) is a theme for [Hugo](https://gohugo.io/), a static website generator written in Go. Where Hugo is often used for blogs, this theme is designed with documentation in mind.
{{% notice tip %}}Relearn theme works with a _page tree structure_ to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "cont/pages/_index.md"%}})
{{% notice info %}}
The theme initially was a fork of the great [hugo-theme-learn](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 hugo-theme-learn.
{{% /notice %}}
## Main features
* [Automatic Search]({{%relref "basics/configuration/_index.md#activate-search" %}})
* [Multilingual mode]({{%relref "cont/i18n/_index.md" %}})
* **Unlimited menu levels**
* **Automatic next/prev buttons to navigate through menu entries**
* Unlimited menu levels
* Automatic next/prev buttons to navigate through menu entries
* [Image resizing, shadow...]({{%relref "cont/markdown.en.md#images" %}})
* [Attachments files]({{%relref "shortcodes/attachments.en.md" %}})
* [List child pages]({{%relref "shortcodes/children/_index.md" %}})
* [Mermaid diagram]({{%relref "shortcodes/mermaid.en.md" %}}) (flowchart, sequence, gantt)
* [Customizable look and feel and themes variants]({{%relref "basics/customization/_index.md"%}})
* [Buttons]({{%relref "shortcodes/button.en.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.en.md" %}}), [Expand]({{%relref "shortcodes/expand.en.md" %}}), [Tabs]({{%relref "shortcodes/tabs.en.md" %}})
* [Customizable look and feel and theme variants]({{%relref "basics/customization/_index.md"%}})
* [Buttons]({{%relref "shortcodes/button.en.md" %}})
* [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.en.md" %}})
* [Expand]({{%relref "shortcodes/expand.en.md" %}})
* [Tabs]({{%relref "shortcodes/tabs.en.md" %}})
* [File inclusion]({{%relref "shortcodes/include.en.md" %}})
![Screenshot](https://github.com/McShelby/hugo-theme-relearn/raw/main/images/screenshot.png?width=40pc&classes=shadow)
## Contribute to this documentation
Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it
Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it.
{{% notice info %}}
{{% notice note %}}
Your modification will be deployed automatically when merged.
{{% /notice %}}
## Documentation website
This current documentation has been statically generated with Hugo with a simple command : `hugo -t hugo-theme-relearn` -- source code is [available here at GitHub](https://github.com/McShelby/hugo-theme-relearn)
This current documentation has been statically generated with Hugo with a simple command : `hugo -t hugo-theme-relearn`. The source code is [available on GitHub](https://github.com/McShelby/hugo-theme-relearn).
{{% notice note %}}
{{% notice info %}}
Automatically published and hosted thanks to [Netlify](https://www.netlify.com/). Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)
{{% /notice %}}
{{% /notice %}}

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 40 KiB