Markdown

Markdownを使用して、コメントとプロジェクトの概要ページにテキストスタイルを追加することができます。 Swarmでは、Helix Coreサーバに保管されたMarkdownを表示することもできます。 MarkdownをSwarmのレビューの説明内で使用することはできません。

このセクションの内容

• 一般的なMarkdownスタイル
• Markdownの例
• コメント内でMarkdownを使用する
• プロジェクト内のMarkdown

一般的なMarkdownスタイル

以下に、一般的なMarkdownのスタイルを一覧表示しています。使用できるスタイルのリストについては、「Markdownのチートシート」を参照してください。

• 太字と斜体は、**bold**と*italics*で指定することができます。

• 順不同のリストは、アスタリスク(*)マーカーを使用して指定することができます。 プラス記号(+)とマイナス記号(-)を使用することもできます。

  * This
  * That
  * Another

• 順序付きリストは、番号付きマーカーを使用して指定することができます。

  1. First
  2. Second
  3. Third

• ハイパーテキストリンクは、[Link text](http://address/page)の形式で指定することができます。 アンカーテキストを追加する必要がない場合は、マークアップがないテキスト内のURLがリンクされます。
• バッククォート(`)を使用して、インラインテキストをコードとしてマーキングすることができます。

• また、3つのバッククォートを以下のように使用して、コードブロックをマーキングすることもできます。

  ```
  var text = "Some code text";
  alert(text);
  ```

• ハッシュ記号(#)を使用して、ヘッダを定義することができます。

  # Main heading
  ## Sub heading
  ### Lesser heading

• 画像を追加することもできます。 Swarm内の項目を参照する場合は、Swarmビューの絶対URLとSwarmビューの相対URLのどちらを使用してもかまいません。

  ![alt text](https://swarm.company.com/view/depot/www/dev/images/jamgraph-jam.gif "Title Text")
  ![alt text](/view/depot/www/dev/images/jamgraph-jam.gif "Title Text")

  ヒント

  画像ファイルのSwarmビューのURLを検索するには、以下の手順を実行します。

  1. Swarmで[ファイル]タブをクリックし、目的の画像ファイルに移動します。
  2. 画像ファイルをクリックし、[ビュー]タブにその画像ファイルを表示します。
  3. 画像ファイルの[開く]ボタンをクリックし、ブラウザに画像を表示します。
  4. ブラウザのアドレスバーに表示されているURLを確認します。このURLが、画像ファイルのSwarmビューのURLになります。

• テーブルを使用する場合は、区切り記号として列の間に縦線(|)を指定し、位置揃え用としてコロン(:)を使用します。

  | Tables   | Look   | Like this |
  | -------- | ----:  | :-------: |
  | Left     | right  | center    |

• また、大なり記号(>)を使用して、段落全体を引用することもできます。

  > Blockquotes can be displayed like this, using the
  > the greater than sign at the start of the line.
  
  Normal text resumes here.

Markdownの例

以下の例では、Markdownテキストをコメントの中で使用していますが、プロジェクトの概要ページでも同様に表示されます。

以下に、ソーステキストと、最終的な表示結果を示します。

• ソーステキスト
• レンダリングされたMarkdownテキストの表示

ソーステキスト

*Comments* can include **Markdown** text, which allows basic styles to be applied to the text.

You can have unordered lists, like this:
* A line
* Another line
  * A sub list
  * Again
* Back again

Or ordered lists:
1. First
2. Second
3. Third

It is possible to mark text as `code { like: this }` or to define a block of text as code:
```
var i = 1;
var j = 10;
for (i = 1; j != i; i++) {
  print i * j;
}
```

You can also [create hyper links](http://www.perforce.com) which point to other places.

Use the backslash character \ to escape Markdown syntax characters. 
You can escape the following characters:
Asterisk \*			
Underscore \_			
Curly braces \{ \}			
Square brackets \[ \]			
Brackets \( \)
Hash \#			
Plus \+			
Minus \-			
Period \.			
Exclamation point \!

レンダリングされたMarkdownテキストの表示

コメント内でMarkdownを使用する

コメントにMarkdownのコンテンツは表示されますが、未加工のHTMLとJavaScriptのコンテンツが実行されることを防ぐため、Markdownのサポートが制限されます。

コメントでMarkdownスタイルを使用する場合、Swarmはコメントの投稿時にスタイルをレンダリングします。

プロジェクト内のMarkdown

プロジェクトのMAINブランチのルートにREADME Markdownファイルが存在する場合、そのREADME Markdownファイルはプロジェクトの概要ページとして表示されます。

Markdownのコンテンツはデフォルトでプロジェクトの概要ページに表示されますが、未加工のHTMLコンテンツとJavaScriptコンテンツが実行されることを防ぐため、表示内容が制限されます。 これは、Swarmの管理者によって設定されます。

• Swarmの管理者は、プロジェクトの概要ページの表示におけるMarkdownサポートを無効にすることができます。詳細については、「プロジェクトのReadmeファイル」を参照してください。
• Swarm管理者は、Markdownのサポートレベルを設定することができます。詳細については、「Markdown」を参照してください。

READMEの読み込み先となるMAINブランチを変更する方法については、「メインラインブランチの特定」を参照してください。