Qiitaで使えるMarkdownをまとめてみました。
公式チートシートと併用して御覧ください。
#最初に
全てのMarkdownの前後には、基本的に 空白行 を入れる用にしましょう。
空白行で挟まない場合、Markdownと認識されずにデザインが崩れることがあります。
ex)
こんな感じのMarkdownを書きたいとします。
text
code
text
text
引用
text
table
title | title |
---|---|
cell | cell |
text
しかし、以下のように空白行をはさまずに書いてしまうと、、、
text
```
code
```
text
text
> 引用
text
table
title|title
-----|-----
cell|cell
text
こんな感じで大きく崩れて表示されてしまいます。
text
code
text
text
引用
text
table
title | title |
---|---|
cell | cell |
text |
#コード
##コード(インライン)
[ ` ](バッククォート)1つで囲います。(Shift+@)
`code`
ex)
code
##コード(ブロック)
[ ` ](バッククォート)3つで囲います。(Shift+@)
```
code
```
言語・ファイル名を指定することもできます。
```lang
code
```
```filename
code
```
```lang:filename
code
```
ex)
public class MainActivity extends FragmentActivity {
@Override
protected void onCreate( Bundle savedInstanceState ) {
super.onCreate( Bundle savedInstanceState );
}
}
@implementation AppDelegate
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
return YES;
}
@end
##Pre
行頭にスペース4つ以上 or タブを挿入します。
Text
ex)
Text
#テーブル
##基本
[ --- ]と[ | ]で構成されます。
first | second | third
------|--------|-------
cell | cell | cell
cell | cell | cell
cell | cell | cell
[ - ]の数は3つ以上であれば数は自由で、横幅は合わせる必要はありません
first|second|third
------|---|-------
cell|cell|cell
cell |cell |cell
cell| cell| cell
見やすくするために両端に[ | ]をつけることもできます。
|first | second | third |
|------|--------|-------|
| cell | cell | cell |
| cell | cell | cell |
| cell | cell | cell |
ex)
first | second | third |
---|---|---|
cell | cell | cell |
cell | cell | cell |
cell | cell | cell |
##アラインメント
[ : ]の位置でアライメントを指定します。
Align Left|Align Center|Algin Right
:---------|:----------:|----------:
cell | cell | cell
ex)
Align Left | Align Center | Algin Right |
---|---|---|
cell | cell | cell |
#テキスト
##イタリック
[ * ][ _ ]いずれか1つで囲います。
*text*
_text_
ex)
Text
Text
##ボールド
[ * ][ _ ]いずれか2つで囲います。
**text**
__text__
ex)
Text
Text
##ボールドイタリック
[ * ][ _ ]いずれか3つで囲います。
***text***
___text___
ex)
Text
Text
##打ち消し線
[ ~ ]2つで囲います。
~~text~~
ex)
text
##段落
空白行で囲まれた文章が段落として扱われます。
空白行が複数ある場合は、まとめられて1つの段落になります。
段落1
段落2
段落2
段落3
段落3
段落3
段落3
ex)
段落1
段落2
段落2
段落3
段落3
段落3
段落3
##リンク
[title](http://~)
URLの後に["]でマウスをリンク上においた時のポップアップ文字列を指定できます。
[title](http://~ "OnMouse")
また、文章の途中に長いURLを書きたくない場合や、
複数箇所で同じリンクを使いまわしたい場合は、 ID を使ってリンクを参照する事もできます。
IDを使う場合は、 ID名が重複しないよう 注意しましょう。
[link id]: http://~
[リンク][link id]
[リンク] [link id]
IDの宣言位置は実際に使用する部分の後ろに書いた場合でも、ちゃんと動くようです。
(あまりオススメではないですが。。。)
[リンク][link id]
[リンク] [link id]
[link id]: http://~
マウスカーソルをリンク上に移動した時(オンマウス時)に出てくる文字列を、指定することもできます。
その場合は、URLの後ろに[ " ]で囲って書きます。
[link id]: http://~ "title"
[リンク][link id]
[リンク] [link id]
ex)
これはQiitaへのリンクです。
ここにこれを書いておく
[qiita top]: http://qiita.com "Qiita トップ"
IDを使ってもリンクを作れます。
IDを使うとリンクを使いまわすことができます。
##画像埋め込み
上記のリンクの頭に[ ! ]をつけると画像が表示されます。
![alt](http://~)
リンクと同じようにオンマウス時の文字列を指定することもできます。
![alt](http://~ "title")
IDを使用することも可能です。
[image id]: http://~
![alt][image id]
[image id]: http://~ "title"
![alt][image id]
ex)
[image id]: http://cdn.qiita.com/assets/siteid-reverse-cd0519106e5814e34d402b3e821820cf.png "OnMouse"
![Qiitaアイコン][image id]
##リスト(点)
先頭に[ * ]を書きます。
* item
* item
* item
[ * ]の代わりに、[ + ][ - ]でも使っても大丈夫です。
* item
+ item
- item
ex)
- item
- item
- item
##リスト(番号)
数字を先頭にして書きます。
1. item 1
2. item 2
3. item 3
ただし、数値に意味はなく、上から順番に番号が割り振られます。
なので以下のように書いても、結果は上記のものと同じです。
54321. item 1
12345. item 2
00000. item 3
ex)
- item 1
- item 2
- item 3
##リスト(ネスト)
入れ子は半角スペース4つか、タブを使います。
- item 1
- item 1-1
- item 1-3
- item 2
- item 2-1
- item 2-2
ex)
- item 1
- item 1-1
- item 1-3
- item 1-1
- item 2
- item 2-1
- item 2-2
##水平線
[ * ][ + ][ - ]の、いずれか3つ以上で水平線になります。
[ - ]の場合、1本でも描画されます。
間にスペースが入っている場合は無視されて1本の線になります。
***
---
___
* **
-- -
_ _ _
ex)
##引用
先頭に[ > ] を書きます。
また、引用内で入れ子状態にすることもできます。
> text
>
> > text
> > text
>
> text
また、複数行に渡る場合は、先頭に[ > ]を書けば、
それ以下が1つの引用として扱われます。
>
text
>>
text
text
>
text
引用の中でもMarkdownを使用することができます。
> text
>
> > text
> > text
>
> ```
> some code
> ```
ex)
text
text
textsome code
##エスケープ
先頭に[ \ ]を書きます。
\code
ex)
***
###h1
[Qiita](http://qiita.com)
##見出し
先頭に[ # ]を書きます。
[ # ]の数に合わせて <h1> 〜 <h6> となります。
また、文章の次の行に[ = ][ - ]を挿入した場合、
それぞれ <h1> と <h2> になります。
#h1
##h2
###h3
####h4
#####h5
######h6
h1
=
h2
-
ex)
#h1
##h2
###h3
####h4
#####h5
######h6