Markdown 構文ガイド

By default, Stash uses Markdown as its markup language. You can use markdown in the following places:

あらゆるプルリクエストの説明、コメント、または
in README files (if they have the .md file extension).

マークダウンをプレビューするには、Control + Shift + P または Command + Shift + P を使用します。

マークダウン構文

The table below contains examples of Markdown syntax. For a full list of all the Markdown syntax, consult the official documentation on John Gruber's Daring Fireball site.

見出し

# This is an H1
## This is an H2
...
###### This is an H6

段落

Each paragraph begins on a new line. Simply press <return> for a new line.

For example,  
like this.

You'll need an empty line between a paragraph and any following markdown construct, such as an ordered or unordered list, for that to be rendered. Like this:

* Item 1
* Item 2

文字のスタイル

*斜体* 
_斜体_
**太字**
__太字__

番号なしのリスト

* Item 1
* Item 2
* Item 3
    * Item 3a
    * Item 3b
    * Item 3c

番号付きリスト

1. Step 1
2. Step 2
3. Step 3
    a. Step 3a
    b. Step 3b
    c. Step 3c

リスト内のリスト

1. Step 1
2. Step 2
3. Step 3
    * Item 3a
    * Item 3b
    * Item 3c

引用

Introducing my quote:
 
> Neque porro quisquam est qui 
> dolorem ipsum quia dolor sit amet, 
> consectetur, adipisci velit...

インラインコード文字

バッククォートを使用して ` 関数()` を表します。

ここには文字どおり ``バッククォート (`` `)``  があります。

コードブロック

Indent every line of the block by at least 4 spaces or 1 tab. Alternatively, you can also use 3 backtick quote marks before and after the block, like this:

``` 
Text to appear as a code block.
``` 

Within a code block, ampersands (&) and angle brackets (< and >)are automatically converted into HTML entities.

This is a normal paragraph:
    This is a code block.
    With multiple lines.

外部 Web サイトへのリンク

これは [例](http://www.slate.com/"タイトル") インライン リンクです。

[このリンク](http://example.net/) にはタイトル属性はありません。

画像

インライン画像の構文は次のようになります。

![Alt text](/path/to/image.jpg) 
![Alt text](/path/to/image.png "Optional title attribute") 
![Alt text](/url/to/image.jpg)

例:

...
![Mockup for feature A](http://monosnap.com/image/bOcxxxxLGF.png)
...

参照画像のリンクは次のようになります。

![Alt text][id]

ここの "id" とは、リンク参照に似た構文を使用して以前に定義済みである画像参照の名前です。

[id]: url/to/image.jpg "Optional title attribute"

例:

...
<--Collected image definitions-->
[MockupA]: http://monosnap.com/image/bOcxxxxLGF.png "Screenshot of Feature A mockup" 
...
<!--Using an image reference-->
![Mockup for feature A][MockupA]
...

インライン HTML

An example, to add a table:

This is a regular paragraph.

<table>
    <tr>
        <td>Foo</td>
    </tr>
</table>

This is another regular paragraph.

Note that Markdown formatting syntax is not processed within block-level HTML tags. That is, you can’t use Markdown-style *emphasis* inside an HTML block.

See http://daringfireball.net/projects/markdown/syntax#html for more details.

On this page:

README ファイル

From Stash 1.3, you can document a project right in the repository by creating .md or .txt files. If the ReadMe has the .md extension, any Markdown it contains gets rendered straight to the screen when viewed from the file list of the repository.

子ページ