Skip to content

Conversation

@neveler
Copy link
Contributor

@neveler neveler commented Nov 17, 2025

支持 GitHub 风格的 Markdown 提示块(Alert)语法

参考 github-docs

---
title: Alert Test
toc: false
classes: wide
---

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

预览

https://neveler.github.io/HMCL-docs/PR13/test.html

@neveler neveler force-pushed the dev-alert branch 2 times, most recently from 5f88a50 to 99b07e6 Compare November 17, 2025 05:43
@neveler neveler changed the title 支持 github md 的 alert 语法 支持 GitHub 风格的 Markdown 提示块(Alert)语法 Nov 17, 2025
@neveler neveler mentioned this pull request Nov 17, 2025
12 tasks
@neveler
Copy link
Contributor Author

neveler commented Nov 18, 2025

@zkitefly @burningtnt

@burningtnt
Copy link
Member

目前文档内没有大面积使用 [!NOTE] 等语法,引入新的自动脚本会增加维护负担,但不能带来可观的收益。

@burningtnt burningtnt closed this Dec 5, 2025
@neveler
Copy link
Contributor Author

neveler commented Dec 5, 2025

目前文档内没有大面积使用 [!NOTE] 等语法,引入新的自动脚本会增加维护负担,但不能带来可观的收益。

我不认同这个观点,没有使用这种语法是因为当前不支持渲染该语法,如果使用了页面会渲染出一个很丑的引用块。

恰恰相反,我认为当前文档正需要这种 alert 用于提示,如果不引入想要实现相同的需求则需要使用如下方式:

> xxxxxxxxxxx
{: .notice--success }

然而这种语法并不被 GitHub 的 Markdown 所支持。

此外,为避免提高维护成本,本脚本并未依赖正则替换,而是在页面渲染完成后通过操作 HTML 字符串进行处理。我认为这样的方式并不会增加太多的维护负担。

@neveler neveler deleted the dev-alert branch December 5, 2025 13:42
@zkitefly
Copy link
Member

zkitefly commented Dec 5, 2025

我觉得这个并不会增加多少维护成本,而且这样也挺方便的,我觉得可以考虑一下?

@burningtnt
Copy link
Member

我觉得这个并不会增加多少维护成本,而且这样也挺方便的,我觉得可以考虑一下?

行。那 @neveler 你点一下 Restore branches,然后我再看看?

@neveler neveler restored the dev-alert branch December 6, 2025 01:59
@burningtnt
Copy link
Member

burningtnt commented Dec 6, 2025

重新打开 PR 竟然必须要发送一段文本???

@burningtnt burningtnt reopened this Dec 6, 2025
@burningtnt burningtnt requested a review from zkitefly December 6, 2025 03:59
@zkitefly zkitefly merged commit 077b92b into HMCL-dev:main Dec 6, 2025
6 checks passed
@neveler neveler deleted the dev-alert branch December 6, 2025 06:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants