Hatena Markdown

Markdown記法 サンプル集

Markdown記法 サンプル集

見出し

1個から6個シャープで見出しを記述する。

記述例

~~~markdown

見出し1

見出し2

見出し3

見出し4

見出し5
見出し6

~~~

表示例

見出し1

見出し2

見出し3

見出し4

見出し5
見出し6

箇条書きリスト

ハイフン、プラス、アスタリスクのいずれかで箇条書きリストを記述可能。

記述例

markdown - リスト1 - ネスト リスト1_1 - ネスト リスト1_1_1 - ネスト リスト1_1_2 - ネスト リスト1_2 - リスト2 - リスト3

表示例

  • リスト1
    • ネスト リスト1_1
      • ネスト リスト1_1_1
      • ネスト リスト1_1_2
    • ネスト リスト1_2
  • リスト2
  • リスト3

番号付きリスト

記述例

markdown 1. 番号付きリスト1 1. 番号付きリスト1_1 2. 番号付きリスト1_2 1. 番号付きリスト2 1. 番号付きリスト3

表示例

  1. 番号付きリスト1
    1. 番号付きリスト1_1
    2. 番号付きリスト1_2
  2. 番号付きリスト2
  3. 番号付きリスト3

引用

~~~markdown

お世話になります。xxxです。

ご連絡いただいた、バグの件ですが、仕様です。 ~~~

表示例

お世話になります。xxxです。

ご連絡いただいた、バグの件ですが、仕様です。

二重引用

記述例

~~~markdown

お世話になります。xxxです。

ご連絡いただいた、バグの件ですが、仕様です。

お世話になります。 yyyです。

あの新機能バグってるっすね ~~~

表示例

お世話になります。xxxです。

ご連絡いただいた、バグの件ですが、仕様です。

お世話になります。 yyyです。

あの新機能バグってるっすね

pre記法(スペース4 or タブ)

半角スペース4個もしくはタブで、コードブロックをpre表示できます

記述例

~~~markdown # Tab class Hoge def hoge print 'hoge' end end

# Space
class Hoge
  def hoge
    print 'hoge'
  end
end

~~~

表示例

class Hoge
  def hoge
    print 'hoge'
  end
end

class Hoge
  def hoge
    print 'hoge'
  end
end

code記法

バッククォートで文字列を囲むことでコードの一部を表示可能です。

記述例

markdown インストールコマンドは gem install hoge です

表示例

インストールコマンドは gem install hoge です

強調：斜体

アスタリスクもしくはアンダースコア1個で文字列を囲むことで太字にします。

記述例

markdown normal italic normal normal italic normal

表示例

normal italic normal normal italic normal

強調：太字

アスタリスクもしくはアンダースコア2個で文字列を囲むことで太字にします。

記述例

markdown normal bold normal normal bold normal

表示例

normal bold normal normal bold normal

強調：斜体かつ太字

アスタリスクもしくはアンダースコア3個で文字列を囲むことで太字にします。

記述例

markdown normal bold normal normal bold normal

表示例

normal bold normal normal bold normal

水平線

アンダースコア、アスタリスク、ハイフンなどを3つ以上連続して記述することで水平線を表示します。 ※連続するハイフンなどの間にはスペースがあっても良い

記述例

~~~markdown

~~~

表示例

リンク

[表示文字](リンクURL)形式でリンクを記述できます

markdown Google先生

Google先生

定義参照リンク

Markdownの文書の途中に長いリンクを記述したくない場合は、 同じリンクの参照を何度も利用する場合は、リンク先への参照を定義することができます。

~~~markdown こっちからgoogle その他の文章 こっちからもgoogle

~~~

こっちからgoogle その他の文章 こっちからもgoogle

GitHub Flavored Markdown(GFM)

GitHub Flavored Markdown(GFM)はGitHubの独自仕様を加えたMarkdown記法。 以降、GFMと記載します。

GFM:リンクテキスト簡易記法

URLは記述するだけで自動的にリンクになります。

記述例

markdown https://www.google.co.jp/

表示例

https://www.google.co.jp/

GFM:取り消し線

チルダ2個で文字列を囲むことで取り消し線を利用できます。

記述例

markdown 取り消し線

表示例

取り消し線

GFM:pre記法(チルダ×3)

記述例

　~~~
　class Hoge
　  def hoge
　    print 'hoge'
　  end
　end
　~~~

表示例

~~~ class Hoge def hoge print 'hoge' end end ~~~

GFM:pre記法(バッククォート×3)

記述例

markdown 　 　class Hoge 　 def hoge 　 print 'hoge' 　 end 　end 　

表示例

class Hoge
  def hoge
    print 'hoge'
  end
end

GFM:pre記法(シンタックスハイライト)

チルダ、もしくはバッククォート3つの後ろに対象シンタックスの言語名を記述します。

記述例

　~~~ruby
　class Hoge
　  def hoge
　    print 'hoge'
　  end
　end
　~~~

表示例

ruby class Hoge def hoge print 'hoge' end end

GFM:表組み

記述例

markdown |header1|header2|header3| |:--|--:|:--:| |align left|align right|align center| |a|b|c|

表示例

header1 header2 header3
align left align right align center
a b c

GFM:ページ内リンク

GitHubのMarkdownを利用すると、見出し記法を利用した際に アンカーが自動的に作成されます。 そのアンカーを利用したページ内リンクを簡単に作成できます。

~~~markdown

menu

return to menu

header1

header2

~~~

少し省略してますが、こんなかんじのHTMLになります。

~~~html

menu

to header1 to header2

to menu

header1

header2

~~~

参照

QiitaでのMarkdownの使用について Qiitaの目次生成機能について