Skip to content

docs: 修复告诫框标题写法导致的标记失效 - #47

Merged
ceastld merged 1 commit into
mainfrom
docs/fix-admonition-bracket-titles
Sep 24, 2026
Merged

ceastld merged 1 commit into
mainfrom
docs/fix-admonition-bracket-titles

Conversation

@ceastld

@ceastld ceastld commented Sep 24, 2026

Copy link
Copy Markdown
Contributor

问题

Docusaurus 告诫框(admonition)使用空格标题写法时,在线上会被当成普通段落渲染,页面上出现裸露的 :::warning … / :::caution … 文本,而不是样式化的告诫框。

失效写法(空格标题):

:::warning 安全提示
...
:::

有效写法(方括号标题):

:::caution[跨版本编辑面板配置]
...
:::

用户反馈截图对应页面:https://docs.getquicker.net/v2/xaction/modules/automationscript/ (源文件 docs/v2/xaction/modules/input/automationscript.md),其中 :::warning 安全提示 与 :::caution … 均以纯文本显示。

修复

将全部空格标题告诫框改为方括号标题形式 :::type[标题]。仅改标题写法,不改动正文内容(automationscript 中 caution 标题去掉了反引号,因标题内不需要,正文已有说明)。

受影响页面(8 个文件 / 11 处)

文件 改动
docs/v2/features/action-sharing.md :::note[版本要求]、:::warning[分享前检查内容]
docs/v2/features/floating-actions.md :::note[版本说明]、:::warning[手柄中键:命名分组关闭,未命名可能删除]
docs/v2/features/triggers/left-button-plus.md :::warning[多设备与回退]
docs/v2/xaction/guides/web-data-and-form-automation.md :::tip[使用条件]
docs/v2/xaction/guides/web-page-control.md :::tip[新动作优先使用专用操作]
docs/v2/xaction/modules/basic/notify.md :::note[Windows 通知]
docs/v2/xaction/modules/input/automationscript.md :::warning[安全提示]、:::caution[(x, y) 不是 JavaScript 的坐标类型](截图问题页)
docs/v2/xaction/modules/ui/reactui.md :::info[与其它界面步骤怎么选]

已对 docs/**/*.md 全量扫描 ^:::(note|tip|info|warning|caution|danger|success) .+(排除已是 :::type[ 的),无额外匹配。

验证

本地 npm run build 通过;构建产物中 automationscript 页已出现 theme-admonition-warning / theme-admonition-caution,不再残留裸露的 :::warning / :::caution。

请勿直接合并,待 review。

将 :::type 标题 的空格标题形式改为 :::type[标题],
避免 Docusaurus 将其渲染为普通段落。
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying docs-getquicker-net with  Cloudflare Pages  Cloudflare Pages

Latest commit: 99e70df
Status: ✅  Deploy successful!
Preview URL: https://322ad071.docs-getquicker-net.pages.dev
Branch Preview URL: https://docs-fix-admonition-bracket.docs-getquicker-net.pages.dev

View logs

@ceastld
ceastld merged commit 3716a64 into main Sep 24, 2026
1 of 2 checks passed
@ceastld
ceastld deleted the docs/fix-admonition-bracket-titles branch September 24, 2026 19:10
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.

1 participant