Markdownとは？その使い方

Markdownは、プレーンテキストエディタを使ってフォーマットされたテキストを作成できる軽量マークアップ言語です。2004年にJohn Gruberによって最初に作成されたMarkdownは、ドキュメント作成、ブログ、メモ取り、さらにはWebサイトやアプリケーションでのコンテンツフォーマットに広く使用されています。

この記事では、Markdownとは何か、どこで一般的に使用されているか、そして最も重要なフォーマット機能を適用する方法について説明します。

Markdownとは？

Markdownは、Web上でテキストをスタイルするための簡単な方法です。複雑なHTMLタグやWYSIWYGエディタを使用する代わりに、Markdownを使用すると、ユーザーは読みやすいプレーンテキスト構文を使用して記述し、それがHTMLに変換されます。

たとえば、テキストを太字にするには、**this**のように二重のアスタリスクで囲むだけで、リストを作成するには、ダッシュまたは数字を使用できます。

Markdownは、シンプルさと柔軟性のバランスが取れているため、技術者と非技術者の両方のユーザーにとってアクセスしやすいことで人気があります。

Markdownの一般的なユースケース

Markdownは、プレーンテキストをスタイルまたは構造化する必要がある多くの場所で使用されています。

技術ドキュメント

開発者やテクニカルライターは、その読みやすさと、Gitのようなバージョン管理システムとの容易な統合のため、Markdownを使用してドキュメントを作成することがよくあります。

GitHubのREADMEファイル

GitHubは、READMEファイルとドキュメントに対してMarkdownをネイティブにサポートしています。 これは、プロジェクトを紹介し、説明するためのデフォルトの形式です。

ブログとコンテンツライティング

Jekyll、Hugo、Next.jsなどの多くの最新の静的サイトジェネレーターは、コンテンツ作成にMarkdownをサポートしています。 また、GhostやDev.toなどのブログプラットフォームでも使用されています。

メモ取りアプリ

Obsidian、Notion（部分的なサポート）、Bearなどのアプリでは、ユーザーは簡単なフォーマットのためにMarkdown構文を使用してメモを作成できます。

メールフォーマットとメッセージング

一部のメールクライアントやメッセージングプラットフォーム（SlackやDiscordなど）では、太字、斜体、コードブロックなどの基本的なフォーマットのために部分的なMarkdown構文が許可されています。

基本的なMarkdown構文とその使い方

Markdown構文は簡単で、人間が読めるようになっています。ここでは、必要な最も一般的な要素を紹介します。

見出し

#記号を使用して見出しを作成します。#記号の数は、見出しのレベルに対応します。

# H1 - メインタイトル
## H2 - セクションタイトル
### H3 - サブセクションタイトル

強調

斜体または太字でテキストを強調表示できます。

*斜体テキスト* または _斜体テキスト_
**太字テキスト** または __太字テキスト__
***太字と斜体*** または ___太字と斜体___

リスト

Markdownは、順序なしリストと順序付きリストの両方をサポートしています。

  • 順序なしリスト：

    - 項目1
- 項目2
  - サブ項目

  • 順序付きリスト：

    1. 最初の項目
2. 2番目の項目
   1. ネストされた項目

リンク

ハイパーリンクを追加するには、テキストに角かっこを使用し、URLに丸かっこを使用します。

[OpenAIにアクセス](https://www.openai.com)

画像

画像はリンクと同じ構文を使用しますが、感嘆符で始まります。

![代替テキスト](https://example.com/image.png)

引用

引用を作成するには、行の先頭に>を付けます。

> これは引用です。

コードとコードブロック

インラインコードの場合は、テキストをバッククォートで囲みます。

`console.log()`関数を使用します。

複数行のコードブロックの場合は、三重のバッククォートを使用します。

```javascript
function greet(name) {
  return `Hello, ${name}`;
}
```

水平線

3つ以上のダッシュ、アスタリスク、またはアンダースコアを使用して、水平線を作成します。

---

テーブル

Markdownのテーブルはパイプとハイフンを使用します。

| Syntax | Description |
|--------|-------------|
| Header | Title       |
| Cell   | Content     |

Markdownで記述するためのヒント

  • Markdownプレビューツール（VS Code、Typora、StackEditなど）を使用して、出力を即座に確認します。
  • 長いドキュメントを作成する場合は、適切な見出しでセクションを整理します。
  • 明確さを維持するために、一貫したフォーマットを使用します。
  • コメント（HTML形式 <!-- Comment -->）を使用して、最終出力に表示されないメモを残します。