SuperAPI AI 工具集

docs-syntax-help

写作与研究

查看项目

更新于 10-15 21:37

技能介绍

用途:帮助编写和编辑 Elastic 文档所使用的 MyST Markdown(含 Elastic 专有扩展),排查语法错误、修复格式错误的指令,并提供可直接套用的正确写法。

主要能力:涵盖指令基础(冒号围栏、参数、选项、内容与闭合冒号数量)、指令嵌套(外层需比内层多冒号)、note/tip/important/warning 警告框与自定义 admonition、标题与锚点、仓库内链接与跨仓库链接、代码块及显式/自动标注、console 代码块、tab-set 与同步标签页、applies-switch、stepper、dropdown、图像与轮播、表格、列表与定义列表、按钮、脚注、图标与键盘标记、行内格式、注释、替换变量与版本变量、文件包含、CSV 表格、Mermaid 图表、数学公式、changelog、settings 等。

使用方式:描述所需指令或元素即可获得正确语法与可用示例;提交损坏的标记可得到问题定位与修正版本;提问“如何……”时给出最小可复制的语法模式,并解释错误原因。默认整页链接使用 ,锚点、跨仓库与外部链接须显式写明链接文本,不要用链接文本重复页面标题。

限制:部分旧特性在 V3 中不支持,包括条件语句、passthrough 块、侧边栏、tagged regions 与示例块,应改用文件包含等替代方式;代码块内需用反引号围栏而非冒号围栏;警告框中不得堆叠警告框或放置代码块;标签页不可嵌套、不超过 6 个、不可用于下拉菜单中;列表嵌套与内容缩进需四个空格;脚注定义须在文档层级;同一代码块不可混用显式与自动标注;图片须位于引用页面的 toc.yml 或 docset.yml 所在文件夹内。