hugo-theme-relearn/exampleSite/content/_index.en.md
2017-08-20 23:43:49 +02:00

2.3 KiB

title
Learn Theme for Hugo

Hugo learn theme

Hugo-theme-learn is a theme for Hugo, 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 of Grav, 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 %}}

Screenshot

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

{{% notice note %}} Automatically published and hosted thanks to Netlify. Read more about Automated HUGO deployments with Netlify {{% /notice %}}