From 12815aaddcceb9db0583bcf98637baa35d3f6fe8 Mon Sep 17 00:00:00 2001 From: Xin Date: Sat, 28 Dec 2024 16:23:58 +0000 Subject: [PATCH] docs: documentation updates for alerts and syntax highlighting --- exampleSite/content/docs/guide/markdown.md | 2 ++ exampleSite/content/docs/guide/shortcodes/callout.md | 4 ++++ exampleSite/content/docs/guide/syntax-highlighting.md | 2 ++ 3 files changed, 8 insertions(+) diff --git a/exampleSite/content/docs/guide/markdown.md b/exampleSite/content/docs/guide/markdown.md index 029b2b2f..174de821 100644 --- a/exampleSite/content/docs/guide/markdown.md +++ b/exampleSite/content/docs/guide/markdown.md @@ -37,6 +37,8 @@ Blockquote with attribution ### Alerts +{{< new-feature version="v0.9.0" >}} + Alerts are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information. [GitHub-style alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) are supported. Please make sure you are using the latest version of Hextra and [Hugo v0.134.0](https://github.com/gohugoio/hugo/releases/tag/v0.134.0) or later. diff --git a/exampleSite/content/docs/guide/shortcodes/callout.md b/exampleSite/content/docs/guide/shortcodes/callout.md index 3bd3513d..7d8653ca 100644 --- a/exampleSite/content/docs/guide/shortcodes/callout.md +++ b/exampleSite/content/docs/guide/shortcodes/callout.md @@ -10,6 +10,10 @@ A built-in component to show important information to the reader. +> [!NOTE] +> [GitHub-style alerts](../../markdown#alerts) are supported since [v0.9.0](https://github.com/imfing/hextra/releases/tag/v0.9.0). +> It leverages Markdown syntax to render the callout which ensures better portability and readability of the content. + ## Example {{< callout emoji="👾">}} diff --git a/exampleSite/content/docs/guide/syntax-highlighting.md b/exampleSite/content/docs/guide/syntax-highlighting.md index 42c5f617..f1293949 100644 --- a/exampleSite/content/docs/guide/syntax-highlighting.md +++ b/exampleSite/content/docs/guide/syntax-highlighting.md @@ -42,6 +42,8 @@ def say_hello(): ### Link to File +{{< new-feature version="v0.9.2" >}} + You can use the `base_url` attribute to provide a base URL that will be combined with the file name to generate a link. The file name can include a relative path if it specifies the file's location within the base path.