diff options
| author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2023-03-01 11:56:07 +0100 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2023-03-01 11:56:07 +0100 |
| commit | 336622d5e7afd9334cd2de7150d4f16bdf7c24f9 (patch) | |
| tree | ecad27e8e6f87901cd1fffef0db0056d12404c5f | |
| parent | cf591b7c0c598d34896709db6d28598da37e3ff6 (diff) | |
6e32d0591 Update quick-start.md (#1984)
eddd25ff4 Mermaid: reflect latest docs specifications
b2a23b6f5 Mermaid: switch to ESM import
43d83c131 Update index.md
git-subtree-dir: docs
git-subtree-split: 6e32d05910fb9d623ef26b647def10ea0e00cd15
| -rw-r--r-- | content/en/about/security-model/index.md | 2 | ||||
| -rw-r--r-- | content/en/getting-started/quick-start.md | 8 | ||||
| -rw-r--r-- | layouts/_default/_markup/render-codeblock-mermaid.html | 4 | ||||
| -rw-r--r-- | layouts/partials/hooks/before-body-end.html | 5 |
4 files changed, 13 insertions, 6 deletions
diff --git a/content/en/about/security-model/index.md b/content/en/about/security-model/index.md index 66cb15463..d4dacd9bf 100644 --- a/content/en/about/security-model/index.md +++ b/content/en/about/security-model/index.md @@ -57,7 +57,7 @@ For HTML output, this is the core security model: In short: -Templates authors (you) are trusted, but the data you send in is not. +Template and configuration authors (you) are trusted, but the data you send in is not. This is why you sometimes need to use the _safe_ functions, such as `safeHTML`, to avoid escaping of data you know is safe. There is one exception to the above, as noted in the documentation: If you enable inline shortcodes, you also say that the shortcodes and data handling in content files are trusted, as those macros are treated as pure text. It may be worth adding that Hugo is a static site generator with no concept of dynamic user input. diff --git a/content/en/getting-started/quick-start.md b/content/en/getting-started/quick-start.md index 824d6030a..d49997570 100644 --- a/content/en/getting-started/quick-start.md +++ b/content/en/getting-started/quick-start.md @@ -34,7 +34,13 @@ You must also be comfortable working from the command line. ### Commands {{% note %}} -If you are a Windows user, you must run these commands with [PowerShell]. You cannot use Windows Powershell, which is a different application, or the Command Prompt. You may also use a Linux shell if available. +**If you are a Windows user:** + +- Do not use the Command Prompt +- Do not use Windows PowerShell +- Run these commands from [PowerShell] or a Linux terminal such as WSL or Git Bash + +PowerShell and Windows PowerShell are different applications. [PowerShell]: https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows {{% /note %}} diff --git a/layouts/_default/_markup/render-codeblock-mermaid.html b/layouts/_default/_markup/render-codeblock-mermaid.html index 59641551c..94ea0cad0 100644 --- a/layouts/_default/_markup/render-codeblock-mermaid.html +++ b/layouts/_default/_markup/render-codeblock-mermaid.html @@ -1,4 +1,4 @@ -<div class="mermaid"> +<pre class="mermaid"> {{- .Inner | safeHTML }} -</div> +</pre> {{ .Page.Store.Set "hasMermaid" true }} diff --git a/layouts/partials/hooks/before-body-end.html b/layouts/partials/hooks/before-body-end.html index fb7ae20ba..dab653508 100644 --- a/layouts/partials/hooks/before-body-end.html +++ b/layouts/partials/hooks/before-body-end.html @@ -1,6 +1,7 @@ {{ if .Page.Store.Get "hasMermaid" }} - <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> - <script> + <script type="module" async> + import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@9/+esm'; + mermaid.initialize({ startOnLoad: true }); </script> {{ end }} |