使用英语阅读

通过


VS Code 文档创作包新版本

本文由 docs.microsoft.com 团队高级项目经理 Megan Bradley 撰写。

4 月,我们宣布了用于 VS Code 的 Docs 创作包的第一个版本,其中包括 Docs Markdown 扩展、基于 DocFX 的预览版编辑扩展和 markdownlint。 今天,我们很高兴地宣布 Docs 创作包的第二个主要版本,其中包括下列新扩展:

  • 代码拼写检查器 根据常用需求,我们将该离线拼写检查器与 Street Side Software 捆绑在了一起,使贡献者可检查其所有内容(包括代码示例)的拼写问题,而无需通过联机服务进行操作。
  • Docs 文章模板 通过此扩展,可将 Markdown 模板应用到新文件,从而更轻松地以一致的方式创建内容和元数据。
  • Docs 预览 第一版 Docs 创作包中包含的 DocFx 预览的替代项。 新的预览扩展可靠得多,而且以更高的保真度显示 docs.microsoft.com CSS。

可通过上述链接、单个捆绑包或 Docs 创作包分别安装扩展。

文章模板简介

文章模板是主干 Markdown 文件,它们提供标准标题、文件元数据、样板文本和其他基本元素,这些内容遵循 docs.microsoft.com 准则,使得向新文章贡献内容更简单,并且无需再猜测发布要求!

若要基于现有模板创建新文件,只需按 Alt+M 并选择“模板”即可:

应用模板

预览效果更好

以前基于 DocFX 的预览引擎已被全新的 Docs 预览取代,后者具有以下增强功能:

  • 支持与 CommonMark 兼容的 Markdig 分析器,而不是 DocFx-flavored Markdown (DFM)。
  • 最新的 docs.microsoft.com CSS,以更高的保真度呈现自定义 Markdown 元素。
  • 更高的可靠性,使预览呈现速度更快且无滞后。
  • 支持不断扩充的基于 Docs 的 Markdown 扩展列表(当这些扩展可用时)。

参与

Docs Markdown 扩展是开源的 - 我们欢迎你来贡献内容!

请记住,大多数参与需要同意参与者许可协议 (CLA),确定你有权且确实授权我们再我们的软件和内容中使用你的内容。 有关详细信息,请访问 https://cla.microsoft.com 。 提交拉取请求时,CLA 机器人将自动确定你是否需要提供 CLA,并相应地修饰 PR(例如标签、注释)。 直接按机器人提供的说明操作。 在 Microsoft 拥有的所有存储库中,只需执行此操作一次。

反馈

对于我们可如何改进扩展,你有想法吗? 只需提出新问题即可!

要了解最新更新,请记得关注我们的 Twitter 帐户

梦想让开发人员的工作更轻松? 加入我们的团队吧