次の方法で共有

GitHub Codespaces を使って投稿する

GitHub には Codespaces と呼ばれる機能があり、ソフトウェアをローカルにインストールまたは構成しなくても PowerShell ドキュメントに投稿できます。 コードスペースを使用すると、チームが書き込みと編集に使用するのと同じオーサリング ツールが得られます。

ブラウザーでコードスペースを使用して、インターネット経由でホストされている VS Code で投稿を行うことができます。 VS Code がローカルにインストールされている場合は、そこにもコードスペースに接続できます。

使用可能なツール

コードスペースを使用して PowerShell ドキュメントに投稿する場合、エディターには次のツールが既に用意されています。

  • Markdown 構文を確認するための Markdownlint。
  • スペル チェック用の cSpell。
  • Vale によるあなたの散文のチェック。
  • プラットフォーム固有の構文の挿入、投稿のプレビューなどを行う Learn Authoring Pack 。
  • 必要に応じてマークダウンをラップし、読み取りと編集を容易にするための Reflow Markdown 拡張機能。
  • 手動で列を配置しなくても、テーブルを読みやすくするための Table Formatter 拡張機能。
  • 見出しや文章の大文字と小文字を変換するための change-case 拡張機能。
  • ファイルの変更履歴を確認するための GitLens 拡張機能。
  • PowerShell の例の作成および操作のための拡張機能。
  • マークダウンで問題のある文字を見つけるための Visual Studio Code 用 Gremlins トラッカー 。

費用

GitHub Codespaces は、1 か月あたり最大 120 コア時間まで無料で使用できます。 毎月の使用量は、ドキュメントだけでなく、すべてのリポジトリで計算されます。

価格の詳細については、「 GitHub Codespaces の課金について」を参照してください。

ヒント

コンテナーと Docker の使用に慣れている場合は、PowerShell ドキュメント リポジトリ用に定義されている devcontainer を使用して同じエクスペリエンスを得ることができます。 devcontainers の使用に関連するコストはありません。 詳細については、 Dev Containers チュートリアルを参照してください。

GitHub Codespace の作成

PowerShell ドキュメントに投稿するための GitHub Codespace を作成するには、次の手順に従います。

  1. ブラウザーで https://github.com/codespaces を開きます。
  2. ページの右上にある [新しいコードスペース] ボタンを選択します。
  3. [新しいコードスペースの作成] ページで、[リポジトリの選択] ボタンを選択し、投稿するリポジトリの名前 ( MicrosoftDocs/PowerShell-Docsなど) を入力します。
  4. その他の設定はすべて既定値のままにします。
  5. [コードスペースの作成] ボタンを選択します。

次の手順を実行すると、GitHub によってそのリポジトリの新しいコード空間が作成され、自動的に設定されます。 コードスペースの準備ができたら、ページが更新され、コードスペースの Web エディター UI が表示されます。 UI は VS Code に基づいており、同じように動作します。

GitHub Codespace を開く

ブラウザーで GitHub Codespace を開くには、次の手順に従います。

  1. ブラウザーで https://github.com/codespaces を開きます。
  2. このページには、Codespaces が一覧表示されます。 投稿するリポジトリの作成済みコードスペースを見つけて選択します。

コードスペースを選択すると、GitHub によって同じウィンドウで開かれます。 ここから、投稿する準備ができました。

VS Code で GitHub Codespace を開くには、「 Visual Studio Code での GitHub Codespaces の使用」の手順に従います。

GitHub Codespace での記述

ブラウザーまたは VS Code で GitHub Codespace を開くと、ドキュメントへの投稿も同じプロセスに従います。

この記事の残りの部分では、投稿の作成または編集中に GitHub Codespace で実行できる一部のタスクについて説明します。

[some text](destination.md)などのインライン リンクを [some text][01] などの参照リンクに変換する場合は、エディターでリンク先を選択します。 その後、次のいずれかを実行できます。

  1. リンク先を右クリックし、コンテキストメニューから「リファクタリング...」を選択します。
  2. Ctrl+Shift+Rを押します。

どちらのアクションでも、リファクタリング コンテキスト メニューが表示されます。 リンク内の (destination.md) を [def] に置き換えるには、コンテキストメニューから「リンク定義へ展開」を選択します。 名前を入力して定義の名前を変更できます。

PowerShell ドキュメントでは、 [01] や [31]などの 2 桁の数値参照リンク定義を使用します。 記事と概念ドキュメントに関するリファレンス リンク定義のみを使用します。 コマンドレットのリファレンス ドキュメントでは、参照リンク定義を使用しないでください。

散文スタイル違反を修正する

コードスペース内の記事を確認すると、Vale は、最初に記事を開いたとき、および保存するたびに自動的に記事をチェックします。 スタイル違反が検出された場合、Vale は色付きの波線でドキュメント内でそれらを強調表示します。

違反にカーソルを合わせると、違反に関する詳細情報が表示されます。

ルールを説明する Web ページを開くには、ホバー情報でルールの名前を選択します。 ルールを開き、その実装を確認するには、ルールのファイル名 ( .ymlで終わる) を選択します。

ルールでクイック修正がサポートされている場合、違反のホバー情報で「クイック修正...」を選択し、コンテキストメニューから修正候補を選んで適用できます。 +を押すこともできます。強調表示された問題の上にカーソルがある場合は、ルールでサポートされている場合にクイック修正を適用します。

規則でクイック修正がサポートされていない場合は、ルールのメッセージを読み、可能であれば修正してください。 修正方法がわからない場合は、PR を確認するときにエディターが提案を行うことができます。

構文の問題を修正する

コードスペース内の記事を確認すると、Markdownlint は、記事を開く際や入力しながら自動的に記事をチェックします。 Markdownlint で構文の問題が見つかると、文書内で色付きの波線で強調表示されます。

違反にカーソルを合わせると、違反に関する詳細情報が表示されます。 ルールを説明する Web ページを開くには、ホバー情報でルールの ID を選択します。

ルールでクイック修正がサポートされている場合、違反のホバー情報で「クイック修正...」を選択し、コンテキストメニューから修正候補を選んで適用できます。 +を押すこともできます。強調表示された問題の上にカーソルがある場合は、ルールでサポートされている場合にクイック修正を適用します。

規則でクイック修正がサポートされていない場合は、ルールのメッセージを読み、可能であれば修正してください。 修正方法がわからない場合は、PR を確認するときにエディターが提案を行うことができます。

また、記事内のすべての構文違反に修正プログラムを適用することもできます。 これを行うには、コマンド パレットを開き、「 Fix all supported markdownlint violations in the document」と入力します。 入力すると、コマンド パレットによって使用可能なコマンドがフィルター処理されます。 [ドキュメントでサポートされているすべてのマークダウンリント違反を修正する] コマンドを選択します。 これを行うと、Markdownlint はドキュメントを更新して、迅速な修正が必要な違反を解決します。

テーブルの書式設定

Markdown テーブルの書式を設定するには、Markdown 内のテーブルにカーソルを置きます。 コマンド パレットを開き、 Table: Format Current コマンドを検索します。 そのコマンドを選択すると、Markdown によりテーブルが更新され、整列行や余白が追加されるため、可読性が向上します。

次のように定義されたテーブルが変換されます。

| foo | bar | baz |
|:--:|:--|-:|
| a | b | c |

これに:

|  foo  | bar  | baz  |
| :---: | :--- | ---: |
|   a   | b    |    c |

アラートを挿入する

このドキュメントでは 、アラートを 使用して、読者に情報をより目立たせて表示します。

アラートを挿入するには、コマンド パレットを開き、 Learn: Alert コマンドを検索します。 そのコマンドを選択すると、コンテキスト メニューが開きます。 追加するアラートの種類を選択します。 この操作を行うと、アラートの Markdown がドキュメント内のカーソルに挿入されます。

見出しで文のように初めの文字を大文字にする

見出しの大文字と小文字を変換するには、見出しのレベルを設定する先頭の # 記号を除き、見出しのテキストを強調表示します。 テキストが強調表示されたら、コマンド パレットを開き、 Change case sentence コマンドを検索します。 そのコマンドを選択すると、強調表示されたテキストの大文字と小文字が切り替わります。

文書内の任意のテキストに対して大文字と小文字の区別コマンドを使用することもできます。

コマンド パレットを開く

VS Code の コマンド パレット を使用して、多くの便利なコマンドを実行できます。

UI でコマンド パレットを開くには、上部のメニュー バーで [表示] を選択します。 次に、[コマンド パレット...] を選択します。

キーボードでコマンド パレットを開くには、オペレーティング システムのキーの組み合わせを押します。

  • Windows および Linux: Ctrl+Shift+P
  • macOS: Cmd+Shift+P

投稿をプレビューする

投稿をプレビューするには、コマンド パレットを開き、 Markdown: Open Preview コマンドを検索します。 そのコマンドを選択すると、VS Code によって作業中のドキュメントのプレビューが開きます。 プレビューのスタイルは Learn プラットフォームと一致します。

注

サイト相対リンクと相互参照リンクは、プレビューでは機能しません。

コンテンツのリフロー

文書内の段落の行長を制限するには、段落にカーソルを置きます。 次に、コマンド パレットを開き、 Reflow Markdown コマンドを検索します。 コマンドを選択すると、現在の段落の行の長さが構成された長さに更新されます。 リポジトリの場合、その長さは 99 文字です。

ブロック引用符にこのコマンドを使用する場合は、リフローするブロック引用符の段落が空白行で囲まれていることを確認します。 それ以外の場合、コマンドはすべての段落を一緒にリフローします。

注意事項

記事を編集するときは、このコマンドを使用しないでください。 これらのドキュメントの行は、80 文字以下にする必要があります。 現在、リポジトリでフォルダーまたはファイル名ごとに異なる行長を構成する方法はありません。そのため、記事ドキュメントについてはリフローは機能しません。

ドキュメント内のすべての問題を確認する

文書内のすべての構文とスタイルの規則違反を確認するには、[問題] ビューを開きます。

UI で問題ビューを開くには、上部のメニュー バーで [表示] を選択します。 次に、コンテキスト メニューの [問題] を選択します。

キーボードで問題ビューを開くには、オペレーティング システムのキーの組み合わせを押します。

  • Windows および Linux: Ctrl+Shift+M
  • macOS: Cmd+Shift+M

[問題] ビューには、開いているドキュメントのすべてのエラー、警告、および提案が表示されます。 問題を選択して、ドキュメント内の問題までスクロールします。

問題は、種類やテキストの一致でフィルタリングすることができます。

ms.date メタデータの更新

アーティクルの ms.date メタデータを更新するには、コマンド パレットを開き、 Learn: Update "ms.date" Metadata Value コマンドを検索します。 コマンドを選択すると、メタデータが現在の日付に更新されます。

その他のリソース

この記事で説明するタスクとコマンドは、VS Code またはインストールされている拡張機能で実行できるすべてを網羅しているわけではありません。

VS Code の使用の詳細については、次の記事を参照してください。

インストールされている拡張機能の詳細については、次のドキュメントを参照してください。

  • Last updated on