Skip to content

Commit

Permalink
docs: documentation updates for alerts and syntax highlighting
Browse files Browse the repository at this point in the history
  • Loading branch information
imfing committed Dec 28, 2024
1 parent e532637 commit 12815aa
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 0 deletions.
2 changes: 2 additions & 0 deletions exampleSite/content/docs/guide/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions exampleSite/content/docs/guide/shortcodes/callout.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ A built-in component to show important information to the reader.

<!--more-->

> [!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="👾">}}
Expand Down
2 changes: 2 additions & 0 deletions exampleSite/content/docs/guide/syntax-highlighting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 12815aa

Please sign in to comment.