English

Super Markdown is a VS Code extension for people who write, read, maintain, and publish Markdown: API docs, product notes, specs, guides, knowledge-base pages, and project documentation.

Markdown files now open in the Super Markdown Editor by default: a Markdown workbench with outline navigation, source editing, block-based visual editing, and live preview. You can still use Reopen With... or Super Markdown: Open Native Editor whenever you need VS Code's native text editor.

Super Markdown keeps source editing, preview, WYSIWYG editing, formatting, and export aligned around the same Markdown document, so what you write is easier to review and share.

Screenshots

What's New

• The default Markdown experience is now Super Markdown Editor, with source, split preview, preview-only, and WYSIWYG modes in one workspace.
• WYSIWYG mode now supports a richer toolbar, editable tables, lists, math, code blocks, local image insertion, undo/redo, outline navigation, and Mermaid diagram previews.
• Mermaid diagrams render consistently in split preview, WYSIWYG mode, HTML export, PDF export, and image export.
• Export supports HTML, PDF, PNG, JPEG, and all-format output with shared reading styles, KaTeX math, and Mermaid diagrams.
• The built-in Super Markdown syntax guide is easier to open from the command palette.
• Document health checks and safe cleanup stay available before sharing or publishing Markdown files.

Highlights

• Open .md, .markdown, .mdown, and .mkdn files in the Super Markdown Editor by default.
• Use a Markdown workbench with outline navigation, source editing, visual block editing, and live preview.
• Switch between source, split edit, preview, and WYSIWYG modes.
• Use WYSIWYG editing while keeping preview, formatting, and export output aligned with the Markdown source.
• Format Markdown through VS Code Format Document with Super Markdown as the default formatter.
• Export Markdown to HTML, PDF, PNG, JPEG, or all formats.
• Keep headings, lists, tables, code, math, diagrams, preview, and export visually consistent.
• Open a built-in Super Markdown syntax guide and convert Markdown tables to JSON or JSON arrays to Markdown tables.
• Navigate long documents with a floating H1-H6 outline, heading search, active tracking, and adjustable height.
• Click preview content to reveal the matching source line; move the source cursor to scroll the preview.
• Render code blocks with built-in syntax highlighting.
• Render Mermaid diagrams and KaTeX math from bundled local assets.
• Switch the extension UI between English, Simplified Chinese, and VS Code auto mode.
• Choose from multiple reading themes.
• Review safe cleanup changes in a diff before applying them.

Quick Start

1. Install Super Markdown from the VS Code Marketplace or Open VSX.
2. Open a Markdown file in VS Code, Cursor, or another VS Code-compatible editor.
3. The file opens in Super Markdown Editor by default.
4. Use the center editor to write, the left panel to navigate and inspect health, and the right panel to preview.
5. Use Reopen With... or Super Markdown: Open Native Editor if you need VS Code's native editor.

Split Edit Mode shortcut:

• macOS: Cmd+Alt+M
• Windows/Linux: Ctrl+Alt+M

Modes

Document Health

Document health checks are included in the Super Markdown Editor side panel and in Super Markdown: Organize Markdown before sharing or publishing a document.

It checks for:

• Missing H1 heading.
• Skipped heading levels.
• Stale generated table of contents.
• Duplicate heading anchors.
• Broken local links or images.
• Unchecked task count.

Safe Cleanup

Run Super Markdown: Organize Markdown when you want the extension to prepare cleanup edits and a document health report. Super Markdown opens a diff first, so you can review every change before applying it.

It can help with:

• Creating or updating a generated table of contents.
• Normalizing list and task-list spacing.
• Formatting simple Markdown tables.
• Adding or updating H2-H6 section numbering when enabled.
• Running the same formatter used by VS Code Format Document.

Export

Run Super Markdown: Export PDF, Export HTML, Export PNG, Export JPEG, Export All, or Export (Settings).

Export supports headings, tables, task checkboxes, footnotes, code highlighting, Mermaid, and KaTeX. PDF and image export use your configured Chrome/Edge/Chromium path first, then a system Chrome/Edge/Chromium installation.

Export renders from the current Markdown text, so source, preview, WYSIWYG mode, and exported files stay aligned.

Common Commands

Settings

Open VS Code Settings and search for superMarkdown.

Current Limits

• Super Markdown is focused on Markdown files.
• Preview link checks are limited to local links and images that can be resolved from the current document.
• Cleanup is intentionally conservative and opens a diff before changing your document.
• PDF, PNG, and JPEG export need a usable Chrome, Edge, or Chromium executable.
• WYSIWYG mode may adjust harmless Markdown formatting details while preserving document meaning.

Privacy

Super Markdown processes Markdown content locally in the editor and does not send your documents to a remote service by default.

Bug Reports

Report issues here: https://github.com/SivanCola/super-markdown/issues

License

Super Markdown is licensed under the Apache License, Version 2.0. See LICENSE.

简体中文

Super Markdown 是一个面向 VS Code 的 Markdown 写作、阅读、整理和发布扩展，适合接口文档、产品说明、需求文档、知识库页面、项目文档和使用指南。

Markdown 文件现在会默认打开 Super Markdown Editor：它提供大纲导航、源码编辑、块级所见即所得编辑和实时预览。需要原生编辑器时，可以使用 Reopen With... 或 Super Markdown：打开原生编辑器。

Super Markdown 会让源码编辑、预览、所见即所得、格式化和导出围绕同一份 Markdown 文档保持一致，方便编写、检查和分享。

最新版亮点

• Markdown 默认体验已经切换到 Super Markdown Editor，源码、分屏预览、纯预览和所见即所得模式集中在同一个工作台。
• 所见即所得模式支持更完整的工具栏、可编辑表格/列表/数学公式/代码块、本地图片插入、撤销重做、大纲导航，并能像分屏预览一样渲染 Mermaid 图表。
• Mermaid 图表在分屏预览、所见即所得、HTML 导出、PDF 导出和图片导出中都能保持一致。
• 导出支持 HTML、PDF、PNG、JPEG 和全部格式，并复用统一阅读样式、KaTeX 数学公式和 Mermaid 图表。
• 内置 Super Markdown 语法速查可以从命令面板快速打开。
• 文档健康检查和安全整理功能仍可在分享或发布 Markdown 前使用。

功能亮点

• .md、.markdown、.mdown、.mkdn 默认使用 Super Markdown Editor 打开。
• 工作台同时提供大纲导航、源码编辑、块级可视化编辑和实时预览。
• 支持源码、分屏、预览和所见即所得模式。
• 所见即所得编辑会与 Markdown 源码、预览、格式化和导出结果保持一致。
• VS Code Format Document 默认使用 Super Markdown 格式化器。
• 支持导出 HTML、PDF、PNG、JPEG 或全部格式。
• 标题、列表、表格、代码、数学公式、图表、预览和导出保持一致的显示效果。
• 内置 Super Markdown 语法速查，并提供 Markdown 表格与 JSON 互转工具。
• 用 H1-H6 悬浮大纲管理长文档，支持标题搜索、当前标题高亮和高度调整。
• 点击预览内容可定位到源码行，移动源码光标也会同步滚动预览。
• 代码块支持内置语法高亮。
• Mermaid 图表和 KaTeX 数学公式使用本地打包资源渲染。
• 扩展界面支持英文、简体中文和跟随 VS Code 自动切换。
• 提供多种阅读主题。
• 整理 Markdown 前先展示 diff，确认后再应用修改。

快速开始

1. 从 VS Code Marketplace 或 Open VSX 安装 Super Markdown。
2. 在 VS Code、Cursor 或其他兼容 VS Code 的编辑器中打开 Markdown 文件。
3. 文件会默认打开 Super Markdown Editor。
4. 在中间编辑，在左侧导航和检查文档健康，在右侧实时预览。
5. 如需 VS Code 原生编辑器，使用 Reopen With... 或 Super Markdown：打开原生编辑器。

分屏编辑模式快捷键：

• macOS：Cmd+Alt+M
• Windows/Linux：Ctrl+Alt+M

三种模式

文档健康检查

文档健康检查已经合并到 Super Markdown Editor 侧边面板和 Super Markdown：整理 Markdown。分享或发布文档前，运行整理命令即可同时看到健康报告。

它会检查：

• 缺少 H1 标题。
• 标题层级跳跃。
• 生成目录已过期。
• 标题锚点重复。
• 本地链接或图片失效。
• 未完成任务数量。

安全整理

运行 Super Markdown：整理 Markdown 后，扩展会先生成整理结果和文档健康报告，并打开 diff。你可以检查每一处变化，再决定是否应用。

它可以帮助处理：

• 创建或更新生成目录。
• 规范列表和任务列表空格。
• 格式化简单 Markdown 表格。
• 在启用设置后添加或更新 H2-H6 章节编号。
• 复用 VS Code Format Document 的同一套格式化管线。

导出

可以运行 Super Markdown：导出 PDF、导出 HTML、导出 PNG、导出 JPEG、导出全部格式 或 按设置导出。

导出支持标题、表格、任务复选框、脚注、代码高亮、Mermaid 和 KaTeX。PDF 和图片导出优先使用你配置的 Chrome/Edge/Chromium 路径，其次查找系统 Chrome/Edge/Chromium。

导出会从当前 Markdown 文本生成，因此源码、预览、所见即所得和导出结果保持一致。

常用命令

设置

打开 VS Code 设置，搜索 superMarkdown。

当前限制

• Super Markdown 专注于 Markdown 文件。
• 预览链接检查仅覆盖能从当前文档解析到的本地链接和图片。
• 整理功能保持保守，会先打开 diff，再修改你的文档。
• PDF、PNG 和 JPEG 导出需要可用的 Chrome、Edge 或 Chromium。
• 所见即所得模式可能调整一些不影响语义的 Markdown 格式细节。

隐私

Super Markdown 默认在编辑器本地处理 Markdown 内容，不会把你的文档发送到远程服务。

Bug 反馈

• 提交地址：https://github.com/SivanCola/super-markdown/issues

许可证

Super Markdown 使用 Apache License, Version 2.0 授权。详见 LICENSE。