LoginSignup
418
454

More than 5 years have passed since last update.

Markdown書き方メモ

Last updated at Posted at 2014-07-20

はじめに

投稿練習も兼ねてMarkdownの備忘録として作ってみた。

追記(2018年12月21日)
最近、GithubのReadmeを頻繁に書くことが増えたので、改めて編集

見出し

行頭に「#」を挿入すると、見出しに変換されます。
見出しレベルに応じて、#(ハッシュ記号)の数を増やす。

記述例

# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6

結果

見出し1

見出し2

見出し3

見出し4

見出し5
見出し6

テキスト装飾(太字、イタリック)

「*」もしくは「_」で文字を囲めばイタリック体が適用されます。2つ囲めば、太字になります。

記述例

*イタリック*
_イタリック_
**太字**
__太字__

結果

イタリック
イタリック
太字
太字

リスト

文頭に「*」、「+」、「-」のいずれかを入れるとDisc型リスト(ulリスト)になります。
文頭に「1.」、「2.」、「3.」...を入れるとDecimal型リスト(olリスト)になります。
リストの上下に空行を入れる必要があります。

記述例

(空行)
* リスト項目1
+ リスト項目2
- リスト項目3
(空行)

(空行)
1. リスト項目1
2. リスト項目2
3. リスト項目3
(空行)

結果

  • リスト項目1
  • リスト項目2
  • リスト項目3
  1. リスト項目1
  2. リスト項目2
  3. リスト項目3

箇条書きリスト

「-」、「+」、「*」のいずれかで箇条書きリストの記述が可能になります。

記述例

- リスト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を使用する事も可能。
引用の上下に空行を入れる必要がある。

記述例

> 白露型駆逐艦の4番艦、夕立です。
> 第3次ソロモン海戦では、結構頑張ったっぽい?
> でも、何気に「アイアンボトム・サウンド」って、ホントに怖い言葉よね?

結果

白露型駆逐艦の4番艦、夕立です。
第3次ソロモン海戦では、結構頑張ったっぽい?
でも、何気に「アイアンボトム・サウンド」って、ホントに怖い言葉よね?

二重引用

記述例

> 白露型駆逐艦の4番艦、夕立です。
> 第3次ソロモン海戦では、結構頑張ったぽい?
>>でも、何気に「アイアンボトム・サウンド」って、
>>ホントに怖い言葉よね?

結果

白露型駆逐艦の4番艦、夕立です。
第3次ソロモン海戦では、結構頑張ったっぽい?

でも、何気に「アイアンボトム・サウンド」って、
ホントに怖い言葉よね?

コードブロック

「```」を使用すると、HTML、CSS、JavaScriptなどのコードを表示出来ます。

結果

HelloWorld.php
<?php
 print('HelloWorld!');
?>

短いコードを、コードブロックで囲む場合は、バッククオートで囲む。

記述例

 `print('HelloWorld!');`

結果

print('HelloWorld!');

テーブル

記述例

| Left align | Right align | Center align |
|:-----------|------------:|:------------:|
| This       |        This |     This     |
| column     |      column |    column    |
| will       |        will |     will     |
| be         |          be |      be      |
| left       |       right |    center    |
| aligned    |     aligned |   aligned    |

結果

Left align Right align Center align
This This This
column column column
will will will
be be be
left right center
aligned aligned aligned

水平線

「-」、「*」、「_」などを3つ以上連続して記述することで水平線を表示します。
※連続する記号の間にはスペースがあっても良い。

記述例

---
***
* * *

結果




リンク

リンクしたい文字列を[]、隅カッコで囲み、リンク先URLを()で囲む。

記述例

[Qiita](http://qiita.com/)
[Yahoo!Japan](http://www.yahoo.co.jp/)

結果

Qiita
Yahoo!Japan

取り消し線

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

記述例

~~取り消し線~~

結果

取り消し線

画像

記述方法は、リンクとほぼ同じで[]の前に感嘆符(!)を付けます。
ロゴ画像は、Free vector iconsから引用しています。

記述例

![python](https://image.flaticon.com/icons/svg/2/2181.svg "Python Language logotype free icon")

結果

python

参考文献

Markdown記法 サンプル集

418
454
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
418
454