Genius/hextra
1
0
Fork 0
forked from drowl87/hextra_mirror
Code Pull Requests Activity

docs: documentation updates for alerts and syntax highlighting

Browse Source
This commit is contained in:
Xin 2024-12-28 16:23:58 +00:00
parent e532637cbc
commit 12815aaddc
3 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
exampleSite/content/docs/guide/markdown.md
View File

@ -37,6 +37,8 @@ Blockquote with attribution
### Alerts ### 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. 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. [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. 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.

4
exampleSite/content/docs/guide/shortcodes/callout.md
View File

@ -10,6 +10,10 @@ A built-in component to show important information to the reader.
<!--more--> <!--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 ## Example
{{< callout emoji="👾">}} {{< callout emoji="👾">}}

2
exampleSite/content/docs/guide/syntax-highlighting.md
View File

@ -42,6 +42,8 @@ def say_hello():
### Link to File ### 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. 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. The file name can include a relative path if it specifies the file's location within the base path.