そうだ。Markdown記法を覚えよう。

スポンサーリンク

Markdown記法を使えるようになりたい!と思って、いろいろな場面でMarkdownを使うように心がけてます。(このブログもMarkdownで書いてます。)

そこで、自分が覚えるため、そして、自分が思い出すために書き方をまとめてみました。

見出し

1個から6個のシャープ # を記述することで、見出しになる。
文字列の後ろにシャープ # を付けても表示されない。
文字列の下にハイフン - とかイコール = を記述しても良い。

記述例

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

見出し1
========
見出し2
-----------

表示例

見出し1

見出し2

見出し3

見出し4

見出し5
見出し6

見出し1

見出し2

箇条書き

ハイフン - 、プラス + 、アスタリスク * のいずれかで記述すると、箇条書きで表示される。
インデントしたいときは、半角スペース4つ 記述する。

記述例

- リスト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

番号付きリスト

数字とピリオド 1. を付けて記述すると番号付きリストで表示される。
インデントは箇条書きと同様に、半角スペース4つ記述する。

記述例

1. 番号付きリスト1
    1. 番号付きリスト1-1
    1. 番号付きリスト1-2
1. 番号付きリスト2
1. 番号付きリスト3

表示例

  1. 番号付きリスト1
    1. 番号付きリスト1-1
    2. 番号付きリスト1-2
  2. 番号付きリスト2
  3. 番号付きリスト3

引用、二重引用

> を付けて記述すると、引用表示になる。
> を複数付けると重ねて表示する。

記述例

> ぷーん。
> > 瀬戸弘司って面白いよね。

表示例

ぷーん。

瀬戸弘司って面白いよね。

pre記法

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

記述例

def hello():
      print("Hello world!")

表示例

def hello():
  print("Hello world!")

code記法

バッククォートで文字列を囲むと、コードの一部を表示できる。
また、バッククォート3つ(```)で囲むと、コードブロックを表示できる。

記述例

バッククォートは `Shift+@` で入力できます。

    ```
    def hello():
      print("Hello world!")
    ```

表示例

バッククォートは Shift+@ で入力できます。

    def hello():
      print("Hello world!")

強調

アスタリスク*もしくはアンダースコア_1個で文字列を囲むと、斜体の強調表示ができる。
アスタリスク*もしくはアンダースコア_2個で文字列を囲むと、太字の強調表示ができる。
アスタリスク*もしくはアンダースコア_3個で文字列を囲むと、斜体+太字の強調表示ができる。

記述例

normal *italic* normal
normal _italic_ normal

normal **bold** normal
normal __bold__ normal

normal ***italic+bold*** normal
normal ___italic+bold___ normal

表示例

normal italic normal
normal italic normal

normal bold normal
normal bold normal

normal italic+bold normal
normal italic+bold normal

水平線

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

記述例

***

___

---

*    *    *

表示例




    • *

リンク

[表示文字](リンクURL)形式で記述すると、リンクを表示できる。
同じリンクの参照を何度も利用する場合は、[ID]: URLとIDを定義し、[表示文字][ID]と記述することもできる。
※IDは日本語でも良いらしい。英文字の場合、大文字小文字は区別されないらしい。

記述例

[Google先生はこちら](https://www.google.co.jp/)

[Google]: https://www.google.co.jp/

[ここからもgoogleに行けます][google]

表示例

Googleはこちら

ここからもGoogleに行けます

改行

ただ改行を入れるだけだと表示の時に取り除かれてしまう。
文と文の間に空行を入れると改行できるけど、間延びしてしまう。
そんなときは文末に半角スペース2つを入れておくと、改行されたまま表示できる。

記入例

瀬戸弘司はyoutuberである。
瀬戸康史はイケメン俳優である。

せとこうじはyoutuberであり、  ←半角スペース2つ
イケメン俳優でもある。

表示例

瀬戸弘司はyoutuberである。
瀬戸康史はイケメン俳優である。

せとこうじはyoutuberであり、
イケメン俳優でもある。

まとめ

あとは拡張としてテーブル表示とかもやり方があるみたいだけど、あんまり使わないと思うので今回は省きました。(今後、使う場面が出てきたらここにも書いておこうっと)

Markdownのいいところって、プレーンテキストだからdiffが取りやすくてgitリポジトリでの管理に向いてると思うんです。その上で、表示の時はある程度見栄え良く整形もできるし、シンプルだから覚えるのも簡単というのもいいですね。

仕様書とか設計書とかをMarkdownで書いてるところもあると聞いて、いつか自分のプロジェクトでも採用してみたいなと思ってます。
それが許されるプロジェクトってなかなか無いけどね!

コメント