Repository navigation
docs: 修复告诫框标题写法导致的标记失效 - #47
Merged
Merged
Conversation
将 :::type 标题 的空格标题形式改为 :::type[标题], 避免 Docusaurus 将其渲染为普通段落。
Deploying docs-getquicker-net with
|
| 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
问题
Docusaurus 告诫框(admonition)使用空格标题写法时,在线上会被当成普通段落渲染,页面上出现裸露的
:::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。