基本的なmarkdownの記述まとめ
見出し
記入例
# 見出し1 ## 見出し2 ### 見出し3 #### 見出し4 ##### 見出し5 ###### 見出し6
表示内容
見出し1
見出し2
見出し3
見出し4
見出し5
見出し6
見出しレベル1と2は以下の記法も使うことができます。
見出しレベル 1 ============== 見出しレベル 2 --------------
見出しレベル 1
見出しレベル 2
箇条書きリスト
行頭にハイフン - を付けると箇条書きリストになります。- の代わりに + や * を使うこともできます。
記入例
- 箇条書きリスト1 - 箇条書きリスト2 - 箇条書きリスト3
* 大分類1 + 中分類A - 小分類w - 小分類x + 中分類B - 小分類y * 大分類2 + 中分類C - 小分類z
表示内容
- 箇条書きリスト1
- 箇条書きリスト2
箇条書きリスト3
大分類1
- 中分類A
- 小分類w
- 小分類x
- 中分類B
- 小分類y
- 中分類A
- 大分類2
- 中分類C
- 小分類z
- 中分類C
番号リスト
行頭に数字と . を付けると番号付きリストになります。先頭行の番号は指定した数値になります。2 行目以降の番号は指定した数値ではなく自動的に連番となります。(たとえば、 先頭行を 4. とした場合、 番号は必ず 4, 5, 6, …と振られていきます。)
記入例
1. 番号付きリスト1 2. 番号付きリスト2 3. 番号付きリスト3
表示内容
- 番号付きリスト1
- 番号付きリスト2
- 番号付きリスト3
引用
記入例
> お世話になります。xxxです。 > > ご連絡いただいた、バグの件ですが、仕様です。
表示内容
お世話になります。xxxです。
ご連絡いただいた、バグの件ですが、仕様です。
二重引用
記入例
> お世話になります。xxxです。 > > ご連絡いただいた、バグの件ですが、仕様です。 >> お世話になります。 yyyです。 >> >> あの新機能バグってるっすね
表示内容
お世話になります。xxxです。
ご連絡いただいた、バグの件ですが、仕様です。
お世話になります。 yyyです。
あの新機能バグってるっすね
整形済みテキスト(pre)
記入例
<pre> preタグで囲んだ本箇所は このように改行も そのまま書けます。 </pre>
表示内容
preタグで囲んだ本箇所は このように改行も そのまま書けます。
半角スペース4個もしくはタブで、コードブロックをpre表示する事もできます。
記入例
# Tab class Hoge def hoge print 'hoge' end end --- # Space class Hoge def hoge print 'hoge' end end
表示内容
# Tab
class Hoge
def hoge
print 'hoge'
end
end
# Space
class Hoge
def hoge
print 'hoge'
end
end
インラインコード
記入例
インストールコマンドは `gem install hoge` です
表示内容
インストールコマンドは gem install hoge
です
テキスト装飾
アスタリスクもしくはアンダースコアで文字列を囲むことで表現できます。
記入例
これは*イタリック*です これは**ボールド**です これは***イタリック&ボールド***です これは~~打消し線~~です これは<sup>上付き</sup>です これは<sub>下付き</sub>です
表示内容
これはイタリックです
これはボールドです
これはイタリック&ボールドです
これは打消し線です
これは上付きです
これは下付きです
水平線
アンダースコア、アスタリスク、ハイフンなどを3つ以上連続して記述することで水平線を表示できます。
※連続するハイフンなどの間にはスペースがあっても良いです。
記入例
*** ___ --- * * *
表示内容
リンク表示
[表示文字](リンクURL)
形式でリンクを記述できます。
記入例
[Google先生](https://www.google.co.jp/)
表示内容
Google先生
定義参照リンク
記入例
[こっちからgoogle][google] その他の文章 [こっちからもgoogle][google] [google]: https://www.google.co.jp/
表示内容
こっちからgoogle
その他の文章
こっちからもgoogle
リンクテキスト簡易記法
URLは記述するだけで自動的にリンクになります。
記入例
[https://www.google.co.jp/]
表示内容
テーブル表示
記入例
|header1|header2|header3| |:--|--:|:--:| |align left|align right|align center| |a|b|c|
表示内容
|header1|header2|header3|
|:--|--:|:--:|
|align left|align right|align center|
|a|b|c|
注釈
記入例
注釈のようなことを実現可能です<sup>[1](#note1)</sup> <small id="note1">無理やりですが</small>
表示内容 注釈のようなことを実現可能です1
無理やりですが