宣布推出适用于 Visual Studio 代码的 Docs Markdown 扩展

本文作者为 Adam Kinney,docs.microsoft.com 团队的资深软件工程师。

今天,我们很高兴宣布正式推出适用于 Visual Studio 代码Docs 创作包,让向 docs.microsoft.com 投稿变得前所未有地简单。 此初版包包含三个扩展:

  • Docs Markdown -提供 Markdown 创作协助,包括设置文本格式、插入列表和表格、插入其他内容的链接,以及添加图像和其他资产。 与其他 Markdown 编辑器不同,Docs Markdown 支持 docs.microsoft.com 的自定义 Markdown 扩展,利用如警报和代码片段。
  • DocFX - 提供特定于 docs.microsoft.com 的受限制 Markdown 预览,可帮助你了解 Markdown 文件发布后的外观。
  • markdownlint - 由 David Anson 创作的 Markdown Linter,可帮助确保你的 Markdown 遵循最佳实践。

工作方式

首先,需要从 Visual Studio 市场安装该扩展。 导航到扩展页面后,单击“安装”并按照屏幕上的信息操作:

安装 Docs Markdown 扩展

完成后,应重新加载 Visual Studio 代码,打开 Markdown 文件,即可开始创作! 使用 Alt+M 组合键访问 Docs Markdown 扩展命令面板,可快速设置文本格式(例如设置为粗体或斜体)、插入标准 Markdown 实体(例如编号列表或表格)、插入特定于文档的备注、重要信息及提示标记:

扩展命令面板

可通过兼容 DocFX 的 Markdown 扩展快速插入来自其他文件的代码,并在编辑器中直接预览正在处理的页面:

预览当前编辑的页面

参与

此扩展开放源代码,欢迎添砖加瓦!

大多数参与需要同意参与者许可协议 (CLA),确定你有权且确实授权我们使用你的内容。 有关详细信息,请访问 https://cla.microsoft.com

提交拉取请求时,CLA 机器人将自动确定你是否需要提供 CLA,并相应地修饰 PR(例如标签、注释)。 直接按机器人提供的说明操作。 对于 Microsoft 拥有使用我们 CLA 的所有存储库,仅需要执行一次此操作。

反馈

对于如何改进此扩展有自己的想法? 只需提出新问题即可!

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

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