markdown-syntax-guide

A guide to the extra Markdown syntax supported by @ant-design/agentic-ui’s editor and renderer. It explains formats for tables, charts, videos, cards, alerts, attachments, task lists, file lists, and diagrams.

In plain words
What is it for?
Use it when writing or generating Markdown for charts, tables, videos, cards, alerts, attachments, task lists, tool-use displays, file lists, diagrams, or embedded components.
Why use it?
It helps content display correctly in this specific Markdown system instead of relying on syntax it may not understand. For charts, it explains when to use the built-in chart format and when to use Mermaid, a diagram language.

Skill for Claude CodeCodexCursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/antdigital-ai/agentic-ui/markdown-syntax-guide
Any agent
npx skills add antdigital-ai/agentic-ui --skill markdown-syntax-guide
Clone the repo
git clone --depth 1 https://github.com/antdigital-ai/agentic-ui

Made for: Claude Code, Codex, Cursor.

Per session 110 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 5,967 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00110 $0.05967
Opus 5 $0.00055 $0.02984
Sonnet 5 $0.00022 $0.01193
Haiku 4.5 $0.00011 $0.00597

Measured 3d ago against content hash d305a1944030, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

markdown-syntax-guide scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 3d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/lookup.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/skills/markdown-syntax-guide/SKILL.md · 530 lines

How it starts

The opening of the file, as written. The whole thing — 530 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Markdown 语法指导 Skill

当用户或 AI 需要生成可被 @ant-design/agentic-uiMarkdownEditor / MarkdownRenderer 正确解析的内容时,使用本技能提供与代码实现严格对齐的语法指导。

核心原则(图表场景):先看「图表选型决策表」 → 命中内置 chartType 就用 HTML 注释 + 表格 → 实在没有合适 chartType 才回退 Mermaid 代码块

Skill 激活场景

触发关键词 指导内容
表格, table 基础 Markdown 表格 + chartType: "table" 高级表格 + 图表化表格
视频, video HTML <video> 标签 + ![video:xxx](url) 图片式语法
图表, chart, 柱状图, 饼图, 折线图, 散点, 雷达, 漏斗, 箱线, 直方 优先chartType HTML 注释 + 表格示例(见图表选型决策表)
流程图, 时序图, 甘特图, mermaid 回退方案:内置 chartType 无法表达流程关系时,才给 Mermaid 代码块
卡片, card, link-card 链接卡片语法({"type":"card", ...} + 链接)
提示块, alert, info, warning, success, error ::: 容器语法
附件, attachment ![attachment:xxx](url) 语法
任务列表, task list GFM - [x] / agentic-ui-task 代码块
工具栏, tool use bar agentic-ui-toolusebar 代码块
文件列表, filemap agentic-ui-filemap 代码块
MDX, 内嵌组件 React 组件嵌入(依赖 MDX 渲染上下文)
apaasify aPaaS Schema 代码块
怎么写, 语法, 格式 综合语法速查

语法速查表

1. 表格 (Tables)

基础 Markdown 表格

| 标题 1 | 标题 2 | 标题 3 |
| :----- | :----: | -----: |
| 左对齐 |  居中  | 右对齐 |
| 内容   |  内容  |   内容 |

高级表格(通过 HTML 注释启用)

<!-- {"chartType": "table"} -->

| 姓名 | 年龄 | 职业   |
| :--- | :--- | :----- |
| 张三 | 28   | 工程师 |
| 李四 | 32   | 设计师 |

将表格渲染为图表(柱状图、饼图、折线图等)

<!-- {"chartType": "bar", "x": "产品", "y": "销量", "title": "销量对比"} -->

| 产品 | 销量 |
| :--- | :--- |
| A    | 100  |
| B    | 150  |
| C    | 80   |

支持的 chartTypebar(条形)、column(柱状)、line(折线)、area(面积)、pie(饼图)、donut(环形)、radar(雷达)、scatter(散点)、funnel(漏斗)、table(表格)、descriptions(定义列表)、docCards(卡片列表)、quadrant(四象限图)。


2. 视频 (Video)

方式一:HTML video 标签

<video src="https://example.com/video.mp4" controls width="400"></video>

带完整属性:

<video src="video.mp4" controls autoplay loop muted poster="poster.jpg" width="640" height="360"></video>

Read the full file on GitHub · 530 lines

Files

What ships with it

2 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 3d ago First seen · 530 lines · 110 tokens per session scan A d305a1944030

Subscribe to this mod's changes

markdown-syntax-guide is a skill published in the GitHub repository antdigital-ai/agentic-ui (224 stars, last pushed 21d ago), licensed MIT. It adds 110 tokens to every session and 5,967 once invoked, about $0.0006 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens