LoginSignup
1555
1424

More than 3 years have passed since last update.

Qiita Markdown 書き方 まとめ

Last updated at Posted at 2015-04-12

はじめに

Markdownの書き方をまとめました。
はじめての方でもQiitaをすぐに使えるように出来るだけわかりやすく書いたつもりです。

はじめての方は、下記目次の1~3くらいを覚えて使ってみて、徐々に4以降も使うようにしていけば良いと思います。
(完全な独断でよく使うだろうというものから順番にしています。)

目次

  1. 見出し
  2. コードの挿入
  3. リンクの挿入、画像の埋め込み
  4. 引用
  5. 文字の修飾(イタリック、太字)
  6. リスト
  7. 水平線
  8. テーブル
  9. マークダウンのエスケープ
  10. 補足:ページをMarkdownで見る

1.見出し

文頭に#をつけることで見出しにすることが出来ます。
また、#の数で見出しに重みを下げることが出来ます。
htmlでいうところのh◯の◯が#の数ということです。
以下のように使います。

見出しh1

#見出しh1

見出しh2

##見出しh2

見出しh3

###見出しh3

2.コードの挿入

コードの挿入の基本は```(バッククオート3つ)でコードをくくることです。
` はバッククオートです。クォーテーション ' ではありません。ご注意を。

```
function hello(){
 return "hello world!";
}
```
のように書くと

function hello(){
  return "hello world!";
}

のように記載出来ます。

また、コードにシンタックスハイライトをつけることが出来ます。
各言語にシンタックスハイライトが付けられます。
例えば、phpを例にとると

```php
function hello(){
 return "hello world!";
}
```
のように書くと

function hello(){
  return "hello world!";
}

シンタックスハイライトを使えるのは以下の言語です。(Markdown記法チートシートより引用)
html、css、php、ruby、python… 何でも使えるという認識でとりあえず大丈夫です。

Bash, C#(cs), C++(cpp), CSS, Diff, HTML, XML, Ini, Java, Javascript, PHP, Perl, Python, Ruby, SQL, 1C, AVR Assembler(avrasm), Apache, Axapta, CMake, DOS .bat(dos), Delphi, Django, Erlang, Erlang, REPL, Go, Haskell, Lisp, Lua, MEL, Nginx, Objective C(objectivec), Parser3, Python, profile, Scala, Smalltalk, TeX, VBScript, VHDL, Vala

さらに、コードにファイル名を入れることも出来ます。```php:(ファイル名)とするだけです。

```php:hello.php
function hello(){
 return "hello world!";
}
```
のように書くと

hello.php
function hello(){
  return "hello world!";
}

コードブロックの左上にファイル名がついたことがわかります。

3.リンクの挿入、画像の埋め込み

リンクの挿入は、[リンクテキスト](URL)と書きます。

[Qiita](http://qiita.com/)
のように書くと
Qiita

タイトル付きリンク(タグにtitleがつきます)は[リンクテキスト](URL "タイトル")と書きます。

[Qiita](http://qiita.com/ "キータ")
のように書くと
Qiita

画像の挿入は、![代替テキスト](画像URL)と書きます。

![Qiita](http://cdn.qiita.com/assets/siteid-reverse-6044901aace6435306ebd1fac6b7858c.png)
のように書くと

Qiita

タイトル付きにするにはリンクと同様に![リンクテキスト](URL "タイトル")と書きます。

![Qiita](http://cdn.qiita.com/assets/siteid-reverse-6044901aace6435306ebd1fac6b7858c.png "キータ")
のように書くと

Qiita

ただし、Qiitaでの編集の場合はドラック&ドロップで画像が挿入されるので、画像の挿入を手動で入力する必要はありません。

4.引用

>を書くだけです。
ただし、改行するときはその度に>を書く必要があるので注意です。

>ここに引用文を書きます。

ここに引用文を書きます。

引用の中で別のMarkdown記法を使うことが出来ます。

ちなみに、引用をネストするときは>を複数書くとネストされます。

>引用文です
>>ネストです

引用文です

ネストです

5.文字の修飾(イタリック、太字)

  • イタリック 「_」または「*」で文字をくくります。

_イタリック_
イタリック

*イタリック*
イタリック

  • 太字 「__」または「**」で文字をくくります。

__太字__
太字

**太字**
太字

6.リスト

リストの上下に空白を入れないと正しく表示されないので注意。
また、記号と文の間に半角スペースを入れること。

  • 順序なしリスト

文頭に「*」「+」「-」のいずれかを入れる。

* 順序なしリスト

  • 順序なしリスト
  • 順序つきリスト

文頭に「数字.」を入れる。
見た目はほぼ変わりません。

  1. リスト1
  2. リスト2

7. 水平線

「*」か「-」を3つ以上一行に書く。
以下は全て水平線となる。

***
* * *
---
- - -

全部以下の水平線


8. テーブル

以下のようにテーブルを組みます。
基本は「|」でくくっていくことです。
2行目がポイントで、2行目のコロンの位置によってセル内の文字の配置が変わります。

|左揃え|中央揃え|右揃え|
|:---|:---:|--:|
|align-left|align-center|align-right|
|セルの左揃えです|セルの中央揃えです|セルの右揃えです|

左揃え 中央揃え 右揃え
align-left align-center align-right
セルの左揃えです セルの中央揃えです セルの右揃えです

9. マークダウンのエスケープ

「\」をMarkdownの前につけることでMarkdownを無効化出来ます。
この記事ではこれを多用しました。

\#見出しh1
とすると
#見出しh1
となります。

10. 補足:ページをMarkdownで見る

Qiitaを見ていると「これはどんな記法で書いてあるんだろう」ときになることがあるかもしれません。
そんな時はMarkdown記法で見たいURLの最後に.mdをつければ見ることが出来ます。

参考

Markdown記法チートシート

1555
1424
5

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
1555
1424