VS Code 用 Docs Authoring Pack の新しいリリース

この記事は、docs.microsoft.com チームのシニア プログラム マネージャー、Megan Bradley によって執筆されました。

4 月に、VS Code 用の Docs Authoring Pack の最初のリリースが発表されました。これには、Docs Markdown 拡張機能 (DocFX に基づいて編集をプレビューするための拡張機能)、および markdownlint が含まれています。 本日、Docs Authoring Pack の 2 番目のメジャー リリースを発表いたします。これには、次の新しい拡張機能が含まれています。

• Code Spell Checker。 一般的な需要にこたえて、Street Side Software による、このオフラインのスペルチェックをバンドルしました。これにより、共同作成者は、オンライン サービスを使わずに、コード サンプルを含むすべてのコンテンツをスペルチェックできます。
• Docs Article Templates。 この拡張機能を使用すると、Markdown テンプレートを新しいファイルに適用し、一貫性のある方法でコンテンツやメタデータを簡単に作成することができます。
• Docs Preview。 Docs Authoring Pack の最初のリリースに含まれている DocFx preview の後継。 新しいプレビュー拡張機能は、より堅牢で、docs.microsoft.com CSS をより忠実に表現したものです。

これらの拡張機能は、前述のリンクを通じて、または 1 つのバンドルで、Docs Authoring Pack を使用して個別にインストールできます。

記事テンプレートの概要

記事テンプレートは、標準の見出し、ファイル メタデータ、定型テキスト、および docs.microsoft.com ガイドラインに従ったその他の基本要素を提供するスケルトン Markdown ファイルであり、新しい記事の投稿をより簡単にし、発行要件からの推測を排除します。

既存のテンプレートに基づいて新しいファイルを作成するには、Alt+M キーを押して、[テンプレート] を選択します。

プレビューの向上

以前の DocFX ベースのプレビュー エンジンは、新しい Docs Preview に置き換えられました。これには、次の機能強化が行われています。

• DocFx-flavored Markdown (DFM) ではなく、CommonMark に準拠した Markdig パーサーがサポートされます。
• 最新の docs.microsoft.com CSS により、カスタム Markdown 要素を高い忠実度でレンダリングします。
• 信頼性が向上し、プレビューがより速く、遅れなくレンダリングされるようになりました。
• ドキュメント固有の Markdown 拡張機能が使用可能になるにつれて、増大するリストに対するサポートが拡充されていきます。

投稿

Docs Markdown 拡張機能はオープンソースです。ぜひ投稿をお寄せください。

ほとんどの投稿では、Microsoft が同社のソフトウェアおよびコンテンツで投稿を使用する権利があること、投稿者はその権利を付与する権利があり、実際に付与することを宣言する共同作成者ライセンス契約 (CLA) に同意する必要があることに留意してください。 詳細については、 https://cla.microsoft.com を参照してください。 pull request を送信すると、CLA を提供して PR (ラベル、コメントなど) を適宜装飾する必要があるかどうかを CLA ボットが自動的に決定します。 ボットによって提供される手順にそのまま従ってください。 これを行う必要があるのは、すべての Microsoft 所有リポジトリを通じて 1 回だけです。

フィードバック

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

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

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