基本的な Markdown の使用に関する構文ガイダンス

Azure DevOps Services |Azure DevOps Server 2020 |Azure DevOps Server 2019 |TFS 2018-TFS 2015

重要

Select a version from Azure DevOps Content Version selector.

プラットフォームで利用可能なコンテンツを表示するには、目次の上にあるバージョン セレクターから、この記事の正しいバージョンを確実に選択します。 機能のサポートは、Azure DevOps Services で作業しているか、Team Foundation Server (TFS) から名前が変更された Azure DevOps Server のオンプレミス バージョンで作業しているかによって異なります。
使用しているオンプレミスのバージョンについては、「使用しているプラットフォームまたはバージョン」を参照してください

ここでは、基本的な Markdown 構文のガイダンスと、Azure DevOps 機能での Markdown の使用に関する具体的なガイダンスを紹介します。 common Markdown 規則GitHub flavored 拡張機能の両方を使用できます。

適切なタイミングで適切なガイダンスを用意することは、成功に不可欠です。 Markdownを使用して、豊富な書式設定、テーブル、画像をプロジェクトページ、README ファイル、ダッシュボード、プル要求のコメントに追加します。

Wiki ページでサポートされている構文の詳細については、「 Wiki Markdown のガイダンス」を参照してください。

Markdown を使用して、次の領域にガイダンスを提供することができます。

注意

コードリポジトリでのリッチ Markdown レンダリングは、TFS 2018.2 以降のバージョンでサポートされています。 コードリポジトリには、豊富な README.md ファイルを作成できます。 コードリポジトリ内の MD ファイルの Markdown レンダリングでは、HTML タグ、ブロック引用符、emojis、画像のサイズ変更、および数式がサポートされています。 Wiki の Markdown レンダリングとコード内の MD ファイルにはパリティがあります。

注意

TFS 2017.1 では、ようこそページ、チームダッシュボードの Markdown ウィジェット、およびかんばんボードでの完了の定義では、Markdown のファイルリンクはサポートされなくなりました。 回避策として、マークダウンにテキストとしてファイル リンクを含めることができます。

重要

すべての機能で Markdown 構文がサポートされているわけではありません。 この記事の各セクションでは、構文がサポートされている サポートされている機能について説明します。

ヘッダー

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル |Wiki

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル

サポート対象: 完了の定義 |Markdown ウィジェット |README ファイル

ヘッダーを使用してコメントに構造を与えます。 ヘッダーは長いコメントをセグメント化して、読みやすくします。

見出しを設定するには、行をハッシュ文字 # で始めます。 たとえば、より多くのハッシュ文字を含む行を開始して、注釈をサブ見出しで整理 #### します。 最大 6 レベルの見出しがサポートされています。

例:

# This is a H1 header
## This is a H2 header
### This is a H3 header
#### This is a H4 header
##### This is a H5 header

結果:

Web portal, Headers 1 through 5

段落と改行

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル |Wiki

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル

サポート対象: 完了の定義 |Markdown ウィジェット |README ファイル

テキストを段落に分割するか、改行を使用して、テキストを読みやすくします。

Pull Request

[プル要求のコメント] で、 Enter キーを押し て改行を挿入し、新しい行にテキストを開始します。

例-プル要求のコメント:

Add lines between your text with the **Enter** key.
Your text gets better spaced and makes it easier to read.

結果:

Enter キーを使用して、テキストの間に行 追加します。

テキストの間隔が広くなり、読みやすくなります。

Markdown ファイルまたはウィジェット

Markdown ファイルまたはウィジェットで、改行の前に2つのスペースを入力し、 Enter キー を押して新しい段落を開始します。

Markdown ファイルまたはウィジェットで、改行の前に2つのスペースを入力し、 Enter キー を押して新しい段落を開始します。

Markdown ファイルまたはウィジェットで、改行の前に2つのスペースを入力し、 Enter キー を押します。 この操作により、新しい段落が開始されます。

Markdown ファイルまたはウィジェットの例:

Add two spaces before the end of the line, and then select **Enter**.(space, space, Enter)
A space gets added in between paragraphs.

結果:

行末の前に2つのスペースを追加し、Enter キーを押します。

段落間にスペースが追加されます。

ブロック引用

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル |Wiki

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル

サポート対象: 完了の定義 |Markdown ウィジェット |README ファイル

コメントまたはテキストのコンテキストを設定するために、前のコメントまたはテキストを引用します。

テキストの前に1行のテキストを引用符で囲む > 。 複数 > の文字を使用して、引用符で囲まれたテキストを入れ子にします。 多数の行で同じレベルを使用して、テキストの行の引用ブロックを引用し > ます。

例:

> Single line quote
>> Nested quote
>> multiple line
>> quote

結果:

Markdown での引用符

水平方向のルール

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル |Wiki

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル

サポート対象: 完了の定義 |Markdown ウィジェット |README ファイル

水平方向のルールを追加するには、一連のダッシュである線を追加し --- ます。 を含む行の上の行は、空白にする --- 必要があります。

例:

above
 
----
below

結果:

上図


以下に

強調 (太字、斜体、取り消し線)

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル |Wiki

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル

サポート対象: 完了の定義 |Markdown ウィジェット |README ファイル

文字に太字、斜体、または取り消し線を適用することで、テキストを強調できます。

  • 斜体を適用するには: テキストをアスタリスク * またはアンダースコア _ で囲みます
  • 太字を適用するには: テキストを 2 つのアスタリスク ** で囲みます。
  • 取り消し線を適用するには: テキストを 2 個のチルダ文字 ~~ で囲みます。

これらの要素を結合して、テキストに強調を適用します。

注意

下線付きのテキストをサポートする Markdown 構文はありません。 Wiki ページ内では、HTML タグを使用して <u> 下線付きのテキストを生成できます。 たとえば、は <u>underlined text</u> 下線付きのテキストを生成します。

注意

下線付きのテキストをサポートする Markdown 構文はありません。 TFS 2018.2 以降のバージョンの wiki ページでは、HTML タグを使用して <u> 下線付きのテキストを生成できます。 たとえば、は <u>underlined text</u> 下線付きのテキストを生成します。

注意

下線付きのテキストをサポートする Markdown 構文はありません。

例:

Use _emphasis_ in comments to express **strong** opinions and point out ~~corrections~~  
**_Bold, italicized text_**  
**~~Bold, strike-through text~~**

結果:

Use emphasis in comments to express strong opinions and point out corrections
太字、斜体のテキスト 太字、取り消し線テキスト

コードの強調表示

サポート対象: プル要求 |README ファイル |Wiki

サポート対象: プル要求 |README ファイル

コード強調表示ブロックを使用して、推奨されるコードセグメントを強調表示します。 コードの範囲を示すには、 ``` ブロックの先頭と末尾の両方で新しい行に3つのバックティック引用符 () を付けてラップします。 コードインラインを示すには、1つのバックティック引用符 () を使用してラップし ` ます。

注意

Markdown ウィジェット内に入力されたコードの強調表示は、書式付きテキストとしてコードをレンダリングします。

例:

```
sudo npm install vsoagent-installer -g  
```

結果:

sudo npm install vsoagent-installer -g

例:

To install the Microsoft Cross Platform Build & Release Agent, run the following: `$ sudo npm install vsoagent-installer -g`.

結果:

リリースエージェント & Microsoft クロスプラットフォームビルドをインストールするには、コマンドを実行 $ sudo npm install vsoagent-installer -g します。


Markdown ファイル内では、行の先頭に4つのスペースがあるテキストが自動的にコードブロックに変換されます。

Highlightjsversion v 9.10.0 でサポートされているすべての言語に対して構文の強調表示を有効にするには、コードブロックの言語識別子を設定します。

``` language
code
```

その他の例:

``` js
const count = records.length;
```
const count = records.length;

``` csharp
Console.WriteLine("Hello, World!");
```
Console.WriteLine("Hello, World!");

テーブル

サポート対象: Markdown ウィジェット |プル要求 |README ファイル |Wiki

サポート対象: Markdown ウィジェット |プル要求 |README ファイル

サポート対象: Markdown ウィジェット |README ファイル

構造化されたデータをテーブルで整理します。 テーブルは、関数パラメーター、オブジェクトメソッド、および明確な名前が説明のマッピングに使用されるその他のデータを記述する場合に特に役立ちます。 プル要求、wiki、Markdown ファイル (README ファイルや Markdown ウィジェットなど) でテーブルをフォーマットできます。

  • 各テーブル行を独自の行の配置します。
  • テーブルのセルはパイプ文字 | を使って区切ります
  • テーブルの最初の 2 行は、列の見出しと、テーブルの要素の配置を設定します
  • テーブルの見出しと本文を分けるときにコロン (:) を使って列の配置 (左、中央、右) を指定します
  • 新しい行を開始するには、HTML の改行タグ (<br/>) を使用します (Wiki 内では機能しますが、他の場所では機能しません)
  • 各行は必ず CR または LF で終了してください。
  • テーブルセル内での作業項目またはプル要求 (PR) のメンションの前後には、空白が必要です。

例:

| Heading 1 | Heading 2 | Heading 3 |  
|-----------|:-----------:|-----------:|  
| Cell A1 | Cell A2 | Cell A3 |  
| Cell B1 | Cell B2 | Cell B3<br/>second line of text |  

結果:

Heading 1 Heading 2 Heading 3
Cell A1 Cell A2 Cell A3
Cell B1 Cell B2 Cell B3
テキストの 2 行目

リスト

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル |Wiki

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル

サポート対象: 完了の定義 |Markdown ウィジェット |README ファイル

関連する項目をリストで整理します。 番号付きの順序ありリスト、または行頭文字だけの順序なしリストを追加できます。

順序ありリストは、リスト項目ごとに数字とピリオドで開始します。 順序なしリストは、- で開始します。 各リスト項目は新しい行で開始します。 Markdown ファイルまたはウィジェットで、改行の前に2つのスペースを入力して新しい段落を開始するか、2つの改行を連続して入力して新しい段落を開始します。

順序ありリストまたは番号付きリスト

例:

1. First item.
1. Second item.
1. Third item.

結果:

  1. First item.
  2. Second item.
  3. Third item.

箇条書きリスト

例:

- Item 1
- Item 2
- Item 3

結果:

  • アイテム 1
  • 項目 2
  • アイテム 3

入れ子になったリスト

例:

1. First item.
   - Item 1
   - Item 2
   - Item 3
1. Second item.
   - Nested item 1
   - Nested item 2
   - Nested item 3 

結果:

  1. First item.
    • アイテム 1
    • 項目 2
    • アイテム 3
  2. Second item.
    • Nested item 1
    • Nested item 2
    • Nested item 3

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル |Wiki

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル

サポート対象: 完了の定義 |Markdown ウィジェット |README ファイル

プル要求のコメントと wiki では、HTTP と HTTPS の Url はリンクとして自動的に書式設定されます。 作業項目にリンクするには、 # キーと作業項目 ID を入力し、一覧から作業項目を選択します。

先頭に円記号 () を付けることで、作業項目の自動提案を回避 # \ します。 この操作は、を使用し # てカラー16進数コードを使用する場合に便利です。

Markdown ファイルとウィジェットでは、標準の Markdown link 構文を使用して、URL のテキストハイパーリンクを設定できます。

[Link Text](Link URL)

同じ Git または TFVC リポジトリ内の別の Markdown ページにリンクする場合、リンク先は、リポジトリ内の相対パスまたは絶対パスにすることができます。

ウェルカムページのサポートされているリンク:

  • 相対パス: [text to display](target.md)
  • Git の絶対パス: [text to display](/folder/target.md)
  • TFVC の絶対パス: [text to display]($/project/folder/target.md)
  • URL: [text to display](http://address.com)

Markdown ウィジェットのサポートされているリンク:

  • [text to display](http://address.com)

Wiki のサポートされているリンク:

  • Wiki ページの絶対パス: [text to display](/parent-page/child-page)
  • [text to display](http://address.com)

注意

を使用したファイル共有のドキュメントへのリンクは file:// 、2017.1 以降のバージョンではサポートされていません。 この制限は、セキュリティ上の目的で実装されています。

ウェルカムページまたは Markdown ウィジェットからの相対リンクを指定する方法については、「 ソース管理の相対リンク」を参照してください。

例:

[C# language reference](/dotnet/csharp/language-reference/)

結果:

C# 言語リファレンス

ソース管理ファイルへのリンクは、ウェルカムページと Markdown ウィジェットのどちらで指定するかによって、異なる方法で解釈されます。 システムは、次のように相対リンクを解釈します。

  • ようこそページ: ウェルカムページが存在するソース管理リポジトリのルートからの相対
  • Markdown ウィジェット: チームプロジェクトコレクションの URL ベースに対して相対的

次に例を示します。

ウェルカム ページ 同等の Markdown ウィジェット
/BuildTemplates/AzureContinuousDeploy.11.xaml /Defaultcollection/Fabrikam Fiber/_versionControl # path = $/Tfvc Welcome/BuildTemplates/AzureContinuousDeploy
./page-2.md /Defaultcollection/Fabrikam Fiber/_versionControl # path = $/Tfvc Welcome/page-2 md

Markdown ファイル内では、HTML としてレンダリングされると、すべての見出しにアンカー Id が割り当てられます。 ID は見出しテキストであり、スペースはダッシュ (-) に置き換えられ、すべてが小文字になります。 一般に、次の規則が適用されます。

  • ファイル名に含まれる区切り記号と先頭の空白文字は無視されます
  • 大文字は小文字に変換されます
  • 文字間のスペースは、ダッシュ (-) に変換されます。

例:

###Link to a heading in the page

結果:

セクションに対するアンカー リンクの構文。

[Link to a heading in the page](#link-to-a-heading-in-the-page)

ID はすべて小文字で、リンクでは大文字と小文字が区別されるので、見出し自体で大文字が使用されている場合でも小文字を使用してください。

また、別の Markdown ファイル内の見出しを参照することもできます。

[text to display](./target.md#heading-id)  

Wiki では、別のページの見出しを参照することもできます。
[text to display](/page-name#section-name)

画像

サポート対象: Markdown ウィジェット |プル要求 |README ファイル |Wiki

サポート対象: Markdown ウィジェット |プル要求 |README ファイル

サポート対象: Markdown ウィジェット |README ファイル

問題を強調表示したり、さらに興味深いものを作成したりするには、プル要求の次の側面に画像とアニメーション Gif を追加します。

  • 説明
  • Markdown ファイル
  • Wiki ページ

イメージを追加するには、次の構文を使用します。

![Text](URL)
角かっこ内のテキストは、リンクされているイメージを示し、URL は画像の場所を指しています。

例:


![Illustration to use for new users](https://azurecomcdn.azureedge.net/cvt-779fa2985e70b1ef1c34d319b505f7b4417add09948df4c5b81db2a9bad966e5/images/page/services/devops/hero-images/index-hero.jpg)


結果:

リンクされた画像の図

画像ファイルへのパスは、リンク内の別の Markdown ファイルへのパスと同じように、相対パスまたは Git または TFVC の絶対パスにすることができます。

  • 相対パス: ![Image alt text](./image.png)

  • Git の絶対パス: ![Image alt text](/media/markdown-guidance/image.png)

  • TFVC の絶対パス: ![Image alt text]($/project/folder/media/markdown-guidance/image.png)

  • イメージのサイズ変更: IMAGE_URL =WIDTHxHEIGHT

    注意

    等号の前に必ずスペースを入れてください。

    • 例: ![Image alt text]($/project/folder/media/markdown-guidance/image.png =500x250)
    • 高さの値を残して、幅のみを指定することもできます。 IMAGE_URL =WIDTHx

ヒント

SVG ファイルの種類はサポートされていません。

チェックリストまたはタスク一覧

サポート対象: プル要求 |Wiki

軽量タスク一覧は、PR の説明または wiki ページで、プル要求の作成者またはレビュー担当者として、to do の進行状況を追跡するための優れた方法です。 [Markdown] ツールバーを選択して開始するか、選択したテキストに書式を適用します。

[ ] [x] チェックリストをサポートするには、またはを使用できます。 チェックリストの前に -<space> は、または 1.<space> (任意の数字) を使用します。

例-強調表示されたリストにタスク一覧の Markdown を適用する

PR 内の強調表示されたリストに Markdown タスク一覧形式を適用する

タスク一覧を追加した後、チェックボックスをオンにして項目を完了済みとしてマークできます。 これらのアクションは、Markdown の [] および [x] としてコメント内に表現され、格納されます。

チェックボックスをオンにして、項目を完了済みとしてマークします。

例-リストをタスク一覧として書式設定する

- [ ] A  
- [ ] B  
- [ ] C  
- [x] A  
- [x] B  
- [x] C  


結果:

Checklists

注意

テーブルセル内のチェックリストはサポートされていません。

Emoji

サポート対象: プル要求 |Wiki

プル要求のコメントと wiki ページで、絵文字を使用して文字を追加し、要求のコメントに応答することができます。 :テキスト内で一致する絵文字を取得するために、文字で囲まれていることを入力します。 すべての絵文字がサポートされています。

サポート対象: プル要求

プル要求のコメントでは、絵文字を使用して、文字を追加したり、要求内のコメントに応答したりすることができます。 :テキスト内で一致する絵文字を取得するために、文字で囲まれていることを入力します。 すべての絵文字がサポートされています。

例:

:smile:
:angry:

結果:

Markdown の emojis

Emojis をエスケープするには、文字を使用して囲み ` ます。

例:

`:smile:` `:)` `:angry:`

結果:

:smile: :) :angry:

Markdown 構文を無視するかエスケープして、特定の文字またはリテラル文字を入力します

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル |Wiki

サポート対象: 完了の定義 |Markdown ウィジェット |プル要求 |README ファイル

サポート対象: 完了の定義 |Markdown ウィジェット |README ファイル

構文

例/注意

次のいずれかの文字を挿入するには、プレフィックス \ (円記号) を付けます。
&#92;、円記号
&#96;、バックティック
&#95;、アンダースコア
{}、中かっこ
[]、角かっこ
()、かっこ
#、ハッシュマーク
+、正符号 - (ハイフン)、 . ピリオド
!、感嘆符 * 、アスタリスク

特殊文字を挿入する例を次に示します。
を入力して取得します。 &#92;&#92;
を入力して &#92;&#95; _ を取得します
を入力して取得します &#92;# #
を入力して取得します &#92;( (
を入力して &#92;. 取得します。
を入力して &#92;! 取得します。
を入力して取得します &#92;* *

[Attachments]

サポート対象: プル要求 |README ファイル |Wiki

サポート対象: プル要求 |README ファイル

プル要求のコメントと wiki ページでは、ファイルを添付してポイントを示すことや、提案の背後でより詳細な推測を行うことができます。 ファイルを添付するには、ファイルを [コメント] フィールドまたは wiki ページの編集エクスペリエンスにドラッグアンドドロップします。 また、wiki ページの [コメント] ボックスまたは [書式] ウィンドウの右上にある クリップ を選択することもできます。

プル要求のコメントでは、ファイルを添付してポイントを示すことや、提案の背後でより詳細な推測を行うことができます。 ファイルを添付するには、ファイルを [コメント] フィールドにドラッグアンドドロップします。 また、コメントボックスの右上にある クリップ を選択することもできます。

注意

プル要求の添付ファイルは、TFS 2017.1 以降のバージョンで使用できます。

Web portal, Pull Request, Attach files via drag and drop i

クリップボードに画像がある場合は、クリップボードからコメントボックスまたは wiki ページに貼り付けて、コメントまたは wiki ページに直接レンダリングできます。

画像以外のファイルを添付すると、コメント内のファイルへのリンクが作成されます。 リンクに表示されるテキストを変更するには、角かっこで囲まれた説明テキストを更新します。 添付画像ファイルは、コメントまたは wiki ページに直接表示されます。 添付ファイルを含むコメントまたは wiki ページを保存または更新すると、添付された画像が表示され、添付ファイルをダウンロードするためのリンクを選択できます。

添付ファイルは、次のファイル形式をサポートします。

Type ファイル形式
コード cs (.cs)、拡張マークアップ言語 (.xml)、JavaScript Object Notation (json)、ハイパーテキストマークアップ言語 (.html、.htm)、レイヤー (... r)、Windows PowerShell スクリプト (.ps1)、Roshal Archive (.rar)、リモートデスクトップ接続 (.rdp)、構造化照会言語 (.sql)-注: PR コメントでは、コードの添付ファイルは許可 されていません
圧縮されたファイル ZIP (.zip) と GZIP (gz)
ドキュメント Markdown (md)、Microsoft Office Message (.msg)、Microsoft Project (mpp)、Word (.doc および .docx)、Excel (.xls、.xlsx)、および Powerpoint (.csv、.ppt)、テキストファイル (.pptx)、および pdf (.txt)
画像 PNG (.png)、GIF (.gif)、JPEG (.jpeg と .jpg の両方)、アイコン (.ico)
Visio .VSD (.vsd および .vsdx)
ビデオ MOV (.mov)、MP4 (.mp4)

注意

Microsoft Office メッセージ (.msg) ファイルなどのすべてのファイル形式がプル要求内でサポートされているわけではありません。

数学表記と文字

サポート対象: プル要求 |Wiki

Wiki ページとプル要求では、inline と block KaTeX の両方の表記がサポートされています。 次のサポートされる要素が含まれています。

  • Symbols
  • ギリシャ文字
  • 算術演算子
  • パワーとインデックス
  • 分数と binomials
  • KaTeX でサポートされているその他の要素

数学表記を含めるには、 $ $$ 次の例に示すように、数学表記を符号、インライン、およびブロックに囲みます。

注意

この機能は、Wiki ページと、TFS 2018.2 以降のバージョンのプル要求でサポートされています。

例: ギリシャ文字

$
\alpha, \beta, \gamma, \delta, \epsilon, \zeta, \eta, \theta, \kappa, \lambda, \mu, \nu, \omicron, \pi, \rho, \sigma, \tau, \upsilon, \phi, ...
$  


$\Gamma,  \Delta,  \Theta, \Lambda, \Xi, \Pi, \Sigma, \Upsilon, \Phi, \Psi, \Omega$

結果:

ギリシャ文字

例: 代数表記

Area of a circle is $\pi r^2$

And, the area of a triangle is:

$$
A_{triangle}=\frac{1}{2}({b}\cdot{h})
$$

結果:

代数表記

例: 合計と積分

$$
\sum_{i=1}^{10} t_i
$$


$$
\int_0^\infty \mathrm{e}^{-x}\,\mathrm{d}x
$$     

結果:

合計と積分。