docs: add known limitations (#45)

1 files changed, 15 insertions, 0 deletions

diff --git a/exampleSite/content/posts/getting-started.md b/exampleSite/content/posts/getting-started.md
index a4ce125..85d3db6 100644
--- a/exampleSite/content/posts/getting-started.md
+++ b/exampleSite/content/posts/getting-started.md
@@ -514,3 +514,18 @@ That's it! The theme will auto-load all available SVG sprites provided in the as
 The theme bundles just a small set of hand crafted icons.
 
 {{< sprites >}}
+
+## Known Limitations
+
+### Minify HTML results in spacing issues
+
+Using `hugo --minify` without further configuration or using other minify tools that also minify HTML files might result in spacing issues in the theme and is **not** supported.
+
+After some testing we decided to not spend effort to fix this issue for now as the benefit is very low. There are some parts of the theme where spaces between HTML elements matters but were stripped by minify tools. Some of these issues are related to <!-- spellchecker-disable -->[gohugoio/hugo#6892](https://github.com/gohugoio/hugo/issues/6892).<!-- spellchecker-enable --> While recommendation like "don't depend on whitespace in your layout" sounds reasonable, it seems to be not that straight forward especially for something like embedded icons into the text flow.
+
+If you still want to use Hugo's minify flag you should at least exclude HTML file in your site [configuration](https://gohugo.io/getting-started/configuration/#configure-minify):
+
+```toml
+[minify]
+  disableHTML = true
+```