読者です 読者をやめる 読者になる 読者になる

うまとま君の技術めも

2015年新卒入社した社畜の勉強内容などなど

Markdown

Markdown

Markdown(マークダウン)は、文書を記述するための軽量マークアップ言語のひとつである。

Wikipedia:Markdown

Elements

  • Block Elements
    • Paragraph and Line Breaks
    • Headers
    • Blockquotes
    • Lists
    • Code Blocks
    • Horizontal Rules
  • Span Elements
    • Links
    • Emphasis
    • Code
    • Images
  • Miscellaneous
    • Backslash Escapes
    • Automatic Links

Paragraph and Line Breaks

段落は1つ以上の空行によって区切られる連続したテキストである。
(スペースやタブしか含まれない行は空白としてみなされる)

改行<br/>を挿入したい時は行末に2つ以上のスペースを記述すればよい。
Markdownでは\nが改行に自動的に変換されるのではなく、明示的に改行を記述する必要がある。

Headers

MarkdownではSetextとatxの2タイプのヘッダーの表現方法をサポートしている。

Setext-styleのヘッダーは等号(=)とダッシュ(-)を使用したものである。
( = や - の数はいくつでもおk)

H1 Header  
=========  

H2 Header  
---------

H1 Header

H2 Header

Atx-styleのヘッダーはH1~H6のヘッダーに対応し、1~6個のハッシュ記号(#)で表現する。

# H1 Header
## H2 Header
### H3 Header
#### H4 Header
##### H5 Header
###### H6 Header

H1 Header

H2 Header

H3 Header

H4 Header

H5 Header
H6 Header

また、オプションとしてatx-styleを閉じるときにハッシュ記号を記述してもよい。
(閉じるときのハッシュ記号の数に特に指定はない)

# H1 Header #
#### H4 Header ###########

H1 Header

H4 Header

Blockquotes

Markdownではemail-style > 記号を使用して引用を表現する。
メールで返信するときに > 記号を用いて本文を引用するのと同じような感じ。

> この文章を引用します。  
> 2行目はここです。  
>
> ### Markdownを使用することもできる
>
>     echo "Hello World";
>
> > Blockquoteを入れ子にすることもできる

この文章を引用します。
2行目はここです。

Markdownを使用することもできる

echo "Hello World";

Blockquoteを入れ子にすることもできる

Lists

Markdownでは順序ありのリストと順序なしのリストをサポートしている。

順序なしのリストは *, +, - 記号を使用して表現する。

* red
* blue
* green

----------

1. red
2. green
3. blue
4. black
5. white

----------

* red
  - crimson
  - pink
* blue
  + skyblue
* green

----------

* pタグで囲まない
* pタグで囲まない

----------

* pタグで囲む

* pタグで囲む
  • red
  • blue
  • green

  1. red
  2. green
  3. blue
  4. black
  5. white

  • red
    • crimson
    • pink
  • blue
    • skyblue
  • green

  • pタグで囲まない
  • pタグで囲まない

  • pタグで囲む

  • pタグで囲む

Code Blocks

<pre>タグと<code>タグでcode blockを囲む。 code blockを生成するには4つ以上のスペース又はタブで字下げを行う。

    echo "This is a code block";
echo "This is a code block";

Horizontal Rules

3つ以上の -, *, _ のみで行を記述することで<hr/>タグを表現することができる。

* * *

***

*****

- - -

---------------------------------------





Links

Markdownではinlineとreferenceの2タイプのリンクの表現方法をサポートしている。 両スタイルにおいてリンクは[]で区切られている。

inline-style [うまとま君の技術めも](http://umatomakun.hatenablog.com/ "タイトル")  
相対アドレス [ファイトだよ!](/entry/2014/04/03/025107)  

reference-style [うまとま君の技術めも][myblog]  

[myblog]: http://umatomakun.hatenablog.com/  "タイトル"  
[google]: http://google.com/ 'Google'
[yahoo]:  http://yahoo.co.jp/ (Yahoo)

inline-style うまとま君の技術めも
相対アドレス ファイトだよ!

reference-style うまとま君の技術めも

Emphasis

*, _ でテキストを囲むことで<em>または<strong>タグを表現することができる。

*em tag - asterisks*  
_em tag - underscore_  

**strong tag - asterisks**  
__strong tag - underscore__  

em tag - asterisks
em tag - underscore

strong tag - asterisks
strong tag - underscore

Code

` でテキストを囲むことでコードを表現することができる。

Use the `echo()` function.  
``コード内ではバッククォートも使える (`) ``  

Use the echo() function.
コード内ではバッククォートも使える (`)

Images

![Alt text](http://cdn-ak.f.st-hatena.com/images/fotolife/u/umatomakun/20140403/20140403204609.png "プロフィール画像")  
![Alt text][image]  

Alt text
Alt text

Automatic Links

URLとメールアドレスは自動リンクを生成するためのショートカットスタイルをサポートしている。

<http://example.com/>  
<a href="http://example.com/">http://example.com/</a>  
<a href="http://example.com/" target="_blank">http://example.com/</a>  
<address@example.com>  

http://example.com/
http://example.com/
http://example.com/
address@example.com

Backslash Escapes

次の文字はバックスラッシュでエスケープ可能。

\ backslash
` backtick
* asterisk
_ underscore
{} curly braces
[] square brackets
() parentheses
# hash mark
+ plus sign
- minus sign (hyphen)
. dot
! exclamation mark

参考

http://daringfireball.net/