Visual Studio Code 向け Docs Markdown Extension の発表

この投稿は、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 - 公開時の Markdown ファイルの見た目を確認するのに役立つ、限定された docs.microsoft.com 固有の Markdown プレビュー機能を提供します。
• markdownlint - Markdown がベスト プラクティスに従っていることを確認するのに役立つ、人気のある Markdown リンター (David Anson 作) です。

機能

最初に、Visual Studio Marketplace からインストールする必要があります。 拡張機能のページに移動した後、[Install] をクリックして、画面のメッセージに従うだけです。

終わったら、Visual Studio Code を読み込み直し、Markdown ファイルを開いて、作成を始めてください。 Alt+M キーを押して Docs Markdown Extension のコマンド パレットにアクセスします。このパレットでは、テキストの書式をすばやく設定し (太字や斜体など)、番号付きリストやテーブルなどの標準 Markdown エンティティを挿入し、ノート、重要な情報、ヒントなどの docs 固有のマークアップを挿入することができます。

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

投稿

この拡張機能はオープン ソースであり、機能向上のための協力を歓迎します。

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

pull request を送信すると、CLA を提供して PR (ラベル、コメントなど) を適宜装飾する必要があるかどうかを CLA ボットが自動的に決定します。 ボットによって提供される手順にそのまま従ってください。 これを行う必要があるのは、CLA を使用するすべての Microsoft 所有リポジトリを通じて 1 回だけです。

フィードバック

この拡張機能の向上に関するご意見がある場合は、 新しい提案をご投稿ください。

また、忘れずに Twitter アカウントで最新の更新をフォローしてください。

開発者にとってより良い世界にしたいとお考えですか? ぜひチームにご参加ください!