Zensical Studio 使用指南¶

像重构代码一样重构文档

Zensical Studio 是 Zensical 官方提供的 VS Code 扩展，目前处于公开测试阶段，免费使用。它直接集成在编辑器中，帮助你实时检测文档问题、安全重构文档结构，让写文档的体验接近写代码。

为什么需要 Studio？¶

用 Markdown 写文档时，你可能遇到过这些痛点：

Studio 就是为了解决这些问题而生的。它能即时发现断链，在你重构文件时自动更新所有引用，让你放心大胆地调整文档结构。

Studio 会实时扫描你的文档项目，一旦发现断裂的超链接或无效引用，立刻标记出来。不用等到构建时才发现错误。

当你移动、重命名或重组文件时，Studio 会自动同步更新所有相关的：

这就像 IDE 里的"重命名符号"功能，只不过是针对 Markdown 文档的。

Studio 提供了针对 Python Markdown 方言的精准语法高亮，包括 Zensical/Material for MkDocs 特有的扩展语法（如 admonition、content tabs、code annotations 等），比普通 Markdown 高亮更准确。

在编辑器内提供文档结构导航，快速跳转到任意标题或文件，在大型文档项目中尤其有用。

Studio 同时支持 Zensical 项目和 MkDocs 项目，如果你还在用 MkDocs，也可以直接装上试试。

或者直接访问 VS Code Marketplace 安装。

安装完成后，用 VS Code 打开你的 Zensical 或 MkDocs 项目即可。Studio 会自动识别项目结构并开始工作：

为了获得最佳的语法高亮效果，建议在项目根目录创建或编辑 .vscode/settings.json，添加以下配置：

{
  "files.associations": {
    "*.md": "python-markdown"
  }
}

这会让 VS Code 将 .md 文件识别为 Python Markdown 格式，Studio 的语法高亮就能覆盖所有 Zensical 特有的扩展语法。