[初心者向け]Markdown記法の概要と使い方

2024年5月30日

Markdown記法は、簡潔で読みやすいテキストフォーマットで、ドキュメント作成やブログ投稿、READMEファイルなどに広く使用されている表記法です。
本記事では、Markdown記法の基本的な記法と使い方を紹介します。

やすひら

Markdown記法の概要と使い方を紹介します

この記事でわかること

Markdown記法とは
マークアップ言語とは
Markdown記法の基本構文
Markdown記法の活用例

Markdown記法とは

Markdown記法は、マークアップ言語の1つです。

マークアップ言語

マークアップ言語は、コンピューターが理解しやすい形式で、記述するテキスト形式の言語です。
普通のテキストによる文章では、文字情報のみで見出しや段落を表現することは難しいですが、”タグ”と呼ばれる要素を利用して、見出しや段落等のWebサイトの表現方法まで表現することができます。
代表例として、HTMLやXML、Markdownといった記法があります。

Markdownの特徴

Markdown記法は、同じマークアップ言語の1つであるHTMLやXMLより簡単で読み書きしやすいことが特徴です。
Markdown記法では、見出しや段落などを簡単に表現することができます。

Markdownの基本記法

Markdown記法の基本的な書き方について紹介します。

見出し

見出しは、”#”を使って表現します。

構文

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

記載例

#### 見出し4
##### 見出し5

WordPress表記例

見出し4

見出し5

見出しが表現されています。

テーブル(表)

テーブル(表)は以下で表現します。

構文

| 要素1 | 要素2 |
| ---- | ---- |
| 値1 | 値2 |

記載例

| 要素1 | 要素2 |
| ---- | ---- |
| 値1 | 値2 |

WordPress表記例

要素1	要素2
値1	値2

テーブル(表)が表現されています。

テキスト装飾

テキストを太字/斜体/取り消し線で装飾することができます。

太字

太字は、”**”を使って表現します。

構文

**太字**

記載例

**太字**

WordPress表記例

太字

太字が表現されています。

斜体

斜体は、”*”を使って表現します。

構文

*斜体*

記載例

*斜体*

WordPress表記例

斜体

斜体が表現されています。

取り消し線

取り消し線は、”~~”を使って表現します。

構文

~~取り消し線~~

記載例

~~取り消し線~~

WordPress表記例

~~取り消し線~~

取り消し線が表現されています。

リンク

リンクの挿入は以下で記述します。

構文

[リンクテキスト](URL)

記載例

[やすひらブログ](https:yasuhira-blog.com)

WordPress表記例

やすひらブログ

リンクが挿入されています。

画像

画像の挿入は以下で記述します。

構文

![代替テキスト](画像URL)

記載例

![絵を描くタヌキ](https://yasuhira-blog.com/wp-content/uploads/2024/05/draw_a_picture.jpg)

WordPress表記例

画像が挿入されています。

引用

引用は、”>”を使って表現します。

構文

> 引用テキスト

記載例

> 引用テキスト

WordPress表記例

引用テキスト

引用が表現されています。

コードブロック

コードブロックは、”“`”を使って表現します。

構文

```
ソースコード
```

記載例

```
#include <stdio.h>

int main(void){
     printf("hello world\n");

    return 0;
}
```

WordPress表記例

#include <stdio.h>

int main(void){
     printf("hello world\n");

    return 0;
}

コードブロックが表現されています。

Markdown記法の活用例

Markdown記法の活用例を紹介します。

READMEファイル

GitHub等でソースコードを公開する場合、機能や仕様をREADMEファイルに記載することがあります。
READMEファイルをMarkdown記法で表現することにより、見出しや段落も表現することが出きるため、利用者の理解力が向上します。
GitHubでは、Markdown記法で記載されたREADMEファイルをWebページ化することも可能です。

WordPressのブログ記事執筆

WordPressの投稿画面では、Markdown記法を投稿内容に反映してくれる機能があります。
WordPressの投稿画面で1つずつブロックエディタを設定していくと、多くの時間がかかってしまいます。
まずはMarkdown記法でテキストファイルで草案を記述して、WordPressの投稿画面にコピー&ペーストすると、WordPressが投稿内容に反映してくれるため、記事執筆の生産性が向上します。

まとめ

Markdown記法の概要と使い方について紹介しました。

Markdown記法は

簡単で読みやすいマークアップ言語の1つ
見出し/リスト/文字装飾などが表現できる
ドキュメント作成やブログ投稿で活用できる

Markdown記法は、簡潔に表現することができるマークアップ言語です。
エンジニアのドキュメント作成においても、多く使用することがあるため、文法を習得して効率よくドキュメント作成をしていきましょう。

URLをコピーしました！

[初心者向け]Markdown記法の概要と使い方

Markdown記法とは

マークアップ言語

Markdownの特徴

Markdownの基本記法

見出し

見出し4

見出し5

リスト

箇条書きリスト

番号付きリスト

テーブル(表)

テキスト装飾

太字

斜体

取り消し線

リンク

画像

引用

コードブロック

Markdown記法の活用例

READMEファイル

WordPressのブログ記事執筆

まとめ