Markdown Syntax Cheatsheet（Markdown 语法对照表）

给 Obsidian 的工具栏加一个开关：点一下打开完整的 Markdown 语法对照表，再点一下关掉。 左边是原始语法，右边是这条语法的真实渲染效果，照着抄就行。

功能

• 工具栏（左侧 Ribbon）图标开关，开启时图标高亮
• 77 条语法、11 个分类：标题、文本样式、列表、引用与标注、链接、图片与嵌入、代码、表格、分隔线与排版、数学公式、Obsidian 特有语法
• 左列显示原始语法，右列实时渲染真实效果（可关闭）
• 点击左侧代码块即可复制语法到剪贴板
• 顶部搜索框：输入 表格、callout、脚注 等关键词即时过滤
• 搜索栏固定在顶部不随内容滚动，内容区独立滚动并带常显的侧边滚动条
• 三种打开方式：右侧边栏 / 左侧边栏 / 主区域标签页；另提供弹窗模式
• 可选的状态栏开关按钮

安装

1. 把 md-syntax-cheatsheet 整个文件夹复制到你的库目录下：你的库/.obsidian/plugins/md-syntax-cheatsheet/
2. 重启 Obsidian（或在 设置 → 第三方插件 里点刷新）
3. 设置 → 第三方插件 → 打开「Markdown 语法对照表」的开关

文件夹里必须包含这三个文件：manifest.json、main.js、styles.css。

使用

• 点击左侧工具栏的书本图标（开启时图标变成强调色，再点一次关闭）
• Ctrl/Cmd + P → 切换 Markdown 语法对照表（侧边栏）
• Ctrl/Cmd + P → 在弹窗中查看 Markdown 语法对照表

设置项

设置	说明
显示实时预览	渲染每条语法的真实效果，关闭后只显示文字说明，加载更快
点击语法即可复制	开启后点击左侧代码块复制到剪贴板
显示搜索框	面板顶部的关键词过滤框
打开位置	右侧边栏 / 左侧边栏 / 主区域标签页
预览字号	右侧渲染区域字号，11–20 px
状态栏开关	在底部状态栏也放一个开关按钮

开发

npm install
npm run dev     # 监听 main.ts，改动后自动重新打包
npm run build   # 类型检查 + 生产打包

构建产物是根目录下的 main.js，改了源码记得重新构建。

文件说明

文件	作用
main.ts	插件主逻辑：开关、侧边栏视图、弹窗、设置页
cheatsheet-data.ts	语法数据（分类 + 条目），要加新语法改这里
styles.css	面板样式
manifest.json	插件元信息（id、版本、最低版本要求）
main.js	esbuild 打包产物，Obsidian 实际加载的文件
esbuild.config.mjs / tsconfig.json	构建与类型配置

添加一条语法

在 cheatsheet-data.ts 的 CHEATSHEET 数组里对应分类下加一条即可：

{ syntax: "语法的原始写法", desc: "中文说明" }
{ syntax: "左侧显示的写法", desc: "说明", preview: "右侧真正渲染的内容" }
{ syntax: "无法渲染的语法", desc: "说明", plain: "（这里显示占位文字）" }

改完执行 npm run build，重启插件即可看到。