ブログ
 

Markdownで押さえておきたい記法

       

Markdownとは?

Markdownとはマークアップ言語の1つで、記法に沿って記述することで簡単にHTML文書に変換することができます。
コードの埋め込みなども見やすく表示できるため、Qiitaの記事投稿などにも使用されています。

Markdownの特徴は下記のようなものになります。(日本語Markdownユーザー会 / Markdownとは

  • 手軽に文章構造を明示できること
  • 簡単で、覚えやすいこと
  • 読み書きに特別なアプリを必要としないこと
  • それでいて、対応アプリを使えば快適に読み書きできること

覚えやすく、手軽に見やすい文書を作成できることがMarkdownのメリットと言えるでしょう。

Markdownで押さえておきたい記法

見出し

見出しは「#」で記述します。
「#」の数によって、見出しの重要度を変更できます。
「#」の後には半角スペースが必要です。

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

表示例

見出し1

見出し2

見出し3

見出し4

見出し5
見出し6

箇条書き

箇条書きは「-」(ハイフン)、「+」(プラス)、「*」(アスタリスク)のいずれかで記述します。
「-」、「+」、「*」の後には半角スペースが必要です。

– 項目1
– 項目2
– 項目3

表示例

  • 項目1
  • 項目2
  • 項目3

番号付きリスト

番号付きリストは「1.」のような形式で記述します。
「1.」の後には半角スペースが必要です。
すべて「1.」で記述した場合も表示上は連番になりますので、番号付きリストの途中に項目を追加する場合のことを考慮すると「1.」で統一しておくのが便利かと思います。

1. 項目1
1. 項目2
1. 項目3

表示例

  1. 項目1
  2. 項目2
  3. 項目3

強調

強調は「_」(アンダースコア)もしくは「*」(アスタリスク)で文字を囲みます。
1つで囲むとイタリック体に、2つで囲むと太字になります。

*イタリック体*
**太字**

表示例

イタリック体
太字

コード

「`」(バッククォート)3つで囲むとコードブロックを表現できます。
1つだけで囲んだ場合は、インラインコードになります。

```
console.log(‘Hello World!’);
```

表示例

console.log('Hello World!');

リンク

[表示名](URL)の形式で記述します。

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

表示例

Google

まとめ

今回はMarkdownで押さえておきたい記法をご紹介しました。
Markdownを使えば、見やすい文書を簡単に作成することができます。
文書を共有する際にも便利かと思いますので、機会があればぜひお試しください。

 
  • このエントリーをはてなブックマークに追加