encompass-cs-docs/themes/hugo-theme-learn/exampleSite/content/_index.en.md

2.4 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 multilingual-ready 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 "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" %}})

Screenshot

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 %}}