Visual Studio Code 用の Docs Markdown 拡張機能の発表

この投稿は、docs.microsoft.com チームのシニア ソフトウェア エンジニア Adam Kinneyによって書かれました。

本日は、Visual Studio Code用の Docs Authoring Pack のリリースを発表し、docs.microsoft.com にこれまで以上に貢献しやすくなりました。 このパックの最初のリリースには、次の 3 つの拡張機能が含まれています。

• Docs Markdown - テキストの書式設定、リストとテーブルの挿入、他のコンテンツへのリンクの挿入、画像やその他のアセットの追加など、Markdown 作成の支援を提供します。 他の Markdown エディターとは異なり、Docs Markdown では、アラートやコード スニペットなど、docs.microsoft.com 用のカスタム Markdown 拡張機能がサポートされています。
• DocFX - マークダウン ファイルが発行されたときの外観を確認するのに役立つ、限られた docs.microsoft.com固有の Markdown プレビューを提供します。
• markdownlint - Markdown がベスト プラクティスに従っていることを確認するために、David Anson 人気のあるマークダウン リンターです。

しくみ

まず、Visual Studio Marketplace からインストールする必要があります。 拡張機能ページに移動したら、インストール をクリックし、画面のメッセージに従います。

完了したら、Visual Studio Code を再読み込みし、Markdown ファイルを開き、書き込みを開始する必要があります。 Alt + M キーの組み合わせを使用して Docs Markdown 拡張機能のコマンド パレットにアクセスすると、テキストをすばやく書式設定 (太字や斜体にするなど) したり、番号付きリストや表などの標準の Markdown エンティティを挿入したり、ノート、重要な情報、ヒントのドキュメント固有のマークアップを挿入したりできます。

また、DocFX 互換の Markdown 拡張機能を使用して他のファイルからコードをすばやく挿入し、作業中のページをエディターで直接プレビューすることもできます。

貢献する

拡張機能はオープンソース であり、私たちはそれに対するすべての貢献を歓迎します!

ほとんどの投稿では、共同作成者ライセンス契約 (CLA) に同意して、お客様が投稿を使用する権利を当社に付与する権利があることを確認する必要があります。 詳細については、https://cla.microsoft.comを参照してください。

プル要求を送信すると、CLA ボットは、CLA を提供し、PR を適切に装飾する必要があるかどうかを自動的に判断します (ラベル、コメントなど)。 ボットによって提供される指示に従うだけです。 この操作は、Microsoft が所有するすべてのリポジトリで CLA を使用して 1 回だけ行う必要があります。

フィードバックの送信

拡張機能を改善する方法について考えてください。 新しい問題 開くだけです!

最新の更新プログラムについては、Twitter アカウントの に従うことを忘れないでください。

開発者のために世界をより良くすることを夢見て? 私たちのチームに参加してください!