mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-27 01:33:04 +00:00
42 lines
2.3 KiB
Markdown
42 lines
2.3 KiB
Markdown
|
---
|
||
|
|
title: "Learn Theme for Hugo"
|
||
|
|
---
|
||
|
|
|
||
|
|
# Hugo learn theme
|
||
|
|
|
||
|
|
[Hugo-theme-learn](http://github.com/matcornic/hugo-theme-learn) 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 theme is **fully designed for documentation**.
|
||
|
|
|
||
|
|
This theme is a partial porting of the [Learn theme](http://learn.getgrav.org/) of [Grav](https://getgrav.org/), a modern flat-file CMS written in PHP.
|
||
|
|
|
||
|
|
{{% notice tip %}}Learn theme works with a _page tree structure_ to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "content-organisation/_index.md"%}})
|
||
|
|
{{% /notice %}}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
## Main features
|
||
|
|
|
||
|
|
* [Automatic Search]({{%relref "search/_index.md" %}})
|
||
|
|
* [Multi languages]()
|
||
|
|
* **Unlimited menu levels**
|
||
|
|
* Automatic next/prev buttons to navigate through menu entries
|
||
|
|
* [Image resizing, shadow...]({{%relref "shortcodes/image.md" %}})
|
||
|
|
* [Attachments files]({{%relref "shortcodes/attachments.md" %}})
|
||
|
|
* [List child pages]({{%relref "shortcodes/children/_index.md" %}})
|
||
|
|
* [Mermaid diagram]({{%relref "shortcodes/mermaid.md" %}}) (flowchart, sequence, gantt)
|
||
|
|
* [Buttons]({{%relref "shortcodes/button.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.md" %}}), [Expand]({{%relref "shortcodes/expand.md" %}})
|
||
|
|
* [customizable look and feel]({{%relref "content-organisation/customize-style/_index.md"%}}), [theme variants]({{%relref "content-organisation/customize-style/theme-variants.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-learn` -- source code is [available here at GitHub](https://github.com/matcornic/hugo-theme-learn)
|
||
|
|
|
||
|
|
{{% 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 %}}
|