宣布推出适用于 Visual Studio Code 的 Docs Markdown 扩展
这篇文章是由 docs.microsoft.com 团队高级软件工程师亚当·金尼 撰写的。
今天,我们很高兴宣布发布适用于 Visual Studio Code的 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 Marketplace 安装它。 导航到 扩展页后,只需单击 安装,然后按照屏幕上的消息操作:
Docs Markdown 扩展安装
完成后,应重新加载 Visual Studio Code、打开 Markdown 文件并开始编写! 使用 Alt
+M
组合键访问 Docs Markdown 扩展命令面板,使你可以快速设置文本的格式(例如使文本加粗或斜体)、插入标准 Markdown 实体(如编号列表或表格),以及插入特定于文档的标记以备注、重要信息和提示:
还可以通过 DocFX 兼容的 Markdown 扩展快速插入来自其他文件的代码,并在编辑器中直接预览正在处理的页面:
该扩展 开放源代码,欢迎对此做出任何贡献!
大多数贡献要求你同意参与者许可协议(CLA),确认你有权,实际上这样做,授予我们使用你的贡献的权利。 有关详细信息,请访问 https://cla.microsoft.com。
提交拉取请求时,CLA 机器人会自动确定是否需要提供 CLA 并适当修饰 PR(例如标签、注释)。 只需按照机器人提供的说明进行操作。 只需使用 CLA 在所有Microsoft拥有的存储库中执行此操作一次。
不要忘记关注我们的 Twitter 帐户 的最新更新。
梦想让世界更适合开发人员? 加入我们的团队!