diff --git a/README.md b/README.md index af69cd9e2a..9b9fb62498 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo ## Main features +- Usable offline, no external dependencies - Automatic Search - Multilingual mode for English, Arabic, Simplified Chinese, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Portuguese, Russian, Spanish, Vietnamese, Turkish - Unlimited menu levels diff --git a/exampleSite/content/_index.en.md b/exampleSite/content/_index.en.md index 57dad0316f..292fe77299 100644 --- a/exampleSite/content/_index.en.md +++ b/exampleSite/content/_index.en.md @@ -16,6 +16,7 @@ The theme is a fork of the great [Learn theme](https://github.com/matcornic/hugo See [what's new]({{% relref "basics/migration" %}}) within the latest update. {{% /notice %}} +* Usable offline, no external dependencies * [Automatic Search]({{%relref "basics/configuration#activate-search" %}}) * [Multilingual mode]({{%relref "cont/i18n" %}}) for English, Arabic, Simplified Chinese, Dutch, French, German, Hindi, Indonesian, Japanese, Korean, Portuguese, Russian, Spanish, Vietnamese, Turkish * Unlimited menu levels diff --git a/exampleSite/content/shortcodes/mermaid.en.md b/exampleSite/content/shortcodes/mermaid.en.md index 393cf40256..6ae432fb35 100644 --- a/exampleSite/content/shortcodes/mermaid.en.md +++ b/exampleSite/content/shortcodes/mermaid.en.md @@ -5,6 +5,10 @@ title = "Mermaid" [Mermaid](https://mermaidjs.github.io/) is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown. +{{% notice note %}} +This only works in modern browsers. +{{% /notice %}} + {{% notice warning %}} Due to limitations with [Mermaid](https://github.com/mermaid-js/mermaid/issues/1846), it is currently not possible to use Mermaid code fences in an initially collapsed `expand` shortcode. This is a know issue and [can't be fixed by this theme](https://github.com/McShelby/hugo-theme-relearn/issues/187). {{% /notice %}}