這篇文章是由 docs.microsoft.com 團隊高級軟體工程師亞當·金尼 撰寫的。
今天,我們很高興宣佈發行適用於 Visual Studio Code的 Docs Authoring Pack,讓您比以往更輕鬆地參與 docs.microsoft.com。 此套件的第一個版本包含三個延伸模組:
- Docs Markdown - 提供 Markdown 撰寫協助,包括格式化文字、插入清單和表格、插入其他內容的連結,以及新增影像和其他資產。 與其他 Markdown 編輯器不同,Docs Markdown 支援自定義 Markdown 擴充功能,適用於 docs.microsoft.com,例如警示和代碼段。
- DocFX - 提供有限的 docs.microsoft.com特定 Markdown 預覽,以協助查看您的 Markdown 檔案在發佈時的外觀。
- Markdownlint - David Anson 的熱門 Markdown linter,有助於確保您的 Markdown 遵循最佳做法。
運作方式
首先,您必須從 Visual Studio Marketplace 安裝它。 流覽至 [擴充功能] 頁面後,只要按兩下 [安裝],然後依照畫面上的訊息操作:
安裝
完成後,您應該重載 Visual Studio Code、開啟 Markdown 檔案,並開始撰寫! 使用 Alt
+M
按鍵組合來存取 Docs Markdown 延伸模組命令選擇區,可讓您快速格式化文字(例如,讓文字成為粗體或斜體)、插入標準 Markdown 實體,例如編號清單或表格,以及插入檔特定的標記,以取得筆記、重要資訊和提示:
您也可以透過 DocFX 相容的 Markdown 延伸模組快速插入其他檔案的程式碼,並預覽您直接在編輯器中處理的頁面:
貢獻
延伸模組 開放原始碼,歡迎對此做出任何貢獻!
大部分的捐款都要求您同意「參與者許可協定」(CLA),確認您有權實際執行,並授與我們使用您貢獻的許可權。 如需詳細資訊,請瀏覽 https://cla.microsoft.com。
當您提交提取要求時,CLA-Bot 會自動判斷您是否需要提供 CLA 並適當裝飾 PR(例如標籤、批註)。 只要遵循 Bot 所提供的指示即可。 您只需要使用我們的 CLA 在所有Microsoft擁有的存放庫上執行此動作。
提交意見反應
別忘了遵循我們的 Twitter 帳戶 的最新更新。
夢想讓世界更適合開發人員嗎? 加入我們的小組!