mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-27 09:43:06 +00:00
c108d677b4
- Rename theme from "Learn" to "Relearn" - also change URLs - remove old references - more removal of french and chinese
39 lines
No EOL
2.2 KiB
Markdown
39 lines
No EOL
2.2 KiB
Markdown
---
|
|
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**.
|
|
|
|
{{% 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 %}}
|
|
|
|
## 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**
|
|
* [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/style-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" %}})
|
|
|
|
|
|
|
|
## 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
|
|
|
|
{{% notice info %}}
|
|
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)
|
|
|
|
{{% notice note %}}
|
|
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 %}} |