国民技术 Markdown 文档解析器
本插件用于在 VS Code 中渲染国民技术 Markdown:解析规则、版式与国民技术在线文档 / 手册系统保持一致,适合编写技术文档、核对版式与发布前预览。
与 VS Code 自带的通用 Markdown 预览不同,请使用本插件查看符合国民技术文档规范的显示效果。
我能做什么
- 在侧边打开实时预览,编辑内容会按一定间隔自动刷新(也可在保存后对齐内容)。
- 支持中文、英文两种渲染语言(与国民技术 Web 端手册预览一致)。
- 提供 A4 版式、缩放等浏览方式,便于对照纸质或 PDF 效果。
- 可作为 Markdown 的「格式化程序」:支持 bitfield 块 JSON 规范化、列表空行压缩、题注后空行修正等国民技术文档规则。
怎么用
- 用 VS Code 打开
.md 文件(需识别为 Markdown)。
- 任选一种方式打开预览:
- 在编辑器中右键,选择 「预览-中文」 或 「预览-英文」。
- 点击编辑器右上角的预览按钮,将按 设置里的默认语言 打开预览。
- 按
Ctrl+Shift+P(Mac:Cmd+Shift+P) 打开命令面板,搜索 「NS Markdown」 或 「预览-中文」 / 「预览-英文」,选择对应命令。
预览一般在右侧打开;可同时编辑左侧源文件与右侧预览。
用「格式化文档」走国民技术语法
- 打开任意 Markdown 文件。
- 任选其一:
- 右键 → 「使用…格式化文档」(或 Format Document With…),在列表里选扩展 「国民技术markdown文档解析器」(或显示为发布者
nationstech 下的本扩展)。
- 若已设置默认格式化程序:按
Shift+Alt+F(Mac:Shift+Option+F)执行 格式化文档。
- 若希望 Markdown 默认就用本扩展(不必每次选),在 设置 JSON 中加入:
"[markdown]": {
"editor.defaultFormatter": "nationstech.ns-markdown-preview"
}
(若同时安装了 Prettier 等其它 Markdown 格式化扩展,不设置默认时 VS Code 可能弹出选择或沿用其它默认项。)
设置(可选)
在 VS Code 设置中搜索 「NS Markdown」 或配置项前缀 nsMarkdownPreview:
- 默认渲染语言:在未使用右键指定中/英时,「打开预览」按钮与部分命令会采用这里的语言(中文或英文)。
- 刷新间隔:输入停顿时,过多久再刷新预览(毫秒),数值越大越省资源、延迟略增。
说明
- 若需国民技术 Markdown 的样式与解析结果,请使用本扩展预览;内置 Markdown 预览不会应用国民技术文档规则。
- 若预览未出现,请确认当前文件语言模式为 Markdown,并已安装、启用本扩展。
| |