Markdownのススメ

Intro

すべてのはじまりは、Markdownから (過言)。
とはいえ、Toolは思考を形成することすらあるから侮れない。

TL; DR

まとめると、Markdownはシンプルで直感的な構文を持ち、文書を簡単に書式化するために設計されている。そのシンプルさと直感的な構文で、技術者やライター、ブロガーに広く利用されている。
日常的なメモにすら使える。

• Markdownとは
• Markdownの基本的な使い方
  • 見出し
  • リスト
  • リンク
  • 画像
  • 強調
  • Tables
  • コードブロック
• 他の言語や形式との比較
  • HTMLとの比較
  • LaTeXとの比較
  • その他のマークアップ言語との比較
• Markdownが広く使われる理由

• まとめ

Markdownとは

Markdownは、プレーンテキスト形式で書かれる軽量マークアップ言語で、文書を簡単に書式化するために設計されている。John GruberとAaron Swartzによって2004年に開発され、ウェブ上のコンテンツをHTMLに変換することを目的としている。Markdownはそのシンプルさと直感的な構文で、技術者やライター、ブロガーに広く利用されている。

Markdownの基本的な使い方

Markdownは非常にシンプルな構文を持ち、以下のような基本的な書式を使用する。

見出し

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

### Markdownの基本的な使い方

Markdownは非常にシンプルな構文を持ち、以下のような基本的な書式を使用する。

#### 見出し

リスト

- 項目1
- 項目2
  - サブ項目2.1
  - サブ項目2.2

• 項目1
• 項目2
  • サブ項目2.1
  • サブ項目2.2

リンク

[GitHub](https://github.com)

GitHub

画像

![ﾌﾟｷﾞｬｽ](/2024/07/07/Intro-Markdown/Intro-Markdown.image-11.png)

Tweet

嘘みたいだろ……公式なんだぜ、これで: https://fonts.google.com/specimen/Material+Icons

強調

**太字**
*斜体*

太字
斜体

Tables

| Header 1 | Header 2 |
|----------|----------|
| Cell 1   | Cell 2   |
| Cell 3   | Cell 4   |

Header 1	Header 2
Cell 1	Cell 2
Cell 3	Cell 4

コードブロック

markdown

以下がProgramming言語などを表示するCode Blockの例だ。
(実際は`\`なし)
\```python
for ind, int_score in enumerate(arr_scores):
    print(f"Student {ind + 1}: {int_score}")
\```
Syntax Highlightされていて見やすい。

以下がProgramming言語などを表示するCode Blockの例だ。
(実際は\なし)

for ind, int_score in enumerate(arr_scores):
    print(f"Student {ind + 1}: {int_score}")

Syntax Highlightされていて見やすい。

他の言語や形式との比較

HTMLとの比較

HTMLはウェブページを構築するための標準マークアップ言語だ。以下にいくつかの観点でMarkdownとHTMLを比較する。

• シンプルさ: Markdownはシンプルな構文で、覚えやすく書きやすい。一方、HTMLはタグを使って書式を指定するため、複雑な構文を覚える必要がある。
  • 例: Markdownでリンクを作成する場合、[リンクテキスト](https://example.com) と書きますが、HTMLでは <a href="https://example.com">リンクテキスト</a> と書く必要がある。
• 可読性: Markdownはそのままのテキストでも高い可読性を持ち、プレビューなしでも内容が理解しやすい。HTMLはタグが多く含まれるため、生のテキストは読みづらいことがある。
• 軽量性: Markdownは軽量であり、ファイルサイズが小さいため、バージョン管理システムと組み合わせて使用する際に非常に効率的。

LaTeXとの比較

LaTeXは科学技術文書の作成に主に使用される高機能なマークアップ言語だ。

• 学習曲線: Markdownは非常に簡単で、短時間で習得できるのに対し、LaTeXは複雑であり、習得には時間がかかる。
• 用途: Markdownはブログ記事や技術ドキュメントに適しているが、LaTeXは書籍や学術論文など、長いあるいは複雑な文書に適している。
• 可読性: Markdownはプレーンテキストの状態でも高い可読性を保つが、LaTeXは多くのコマンドを含むため、プレーンテキストの可読性が低い。また、短いドキュメントでも作成に時間がかかる。

その他のマークアップ言語との比較

他のマークアップ言語としては、reStructuredText（reST）やTextileがある。

• シンプルさ: Markdownは最もシンプルで直感的な構文を持ち、初心者でも簡単に使いこなせる。
• 普及度: MarkdownはGitHub、GitLab、Bitbucket、Stack Overflow、Reddit、Slack、Discord、Microsoft Teams、Trello、Notion、Medium、Jekyll、Moodle、Reveal.js、HackMDなど、多くのサービスで広く利用されている。
• 拡張性: MarkdownはGitHub Flavored Markdown（GFM）など、さまざまな拡張が存在し、用途に応じて柔軟に対応できる。

Markdownが広く使われる理由

1. シンプルで直感的な構文

   • Markdownは直感的で覚えやすい構文を持ち、短時間で習得できる。これにより、技術的な知識が少ないユーザーでも簡単にドキュメントを作成できる。

2. 軽量テキスト形式

   • Markdownはプレーンテキスト形式で、HTMLや他のマークアップ言語に比べて軽量である。これにより、バージョン管理システムと組み合わせて使用する際に非常に効率的。

3. 高い可読性

   • Markdownは記述されたままの状態でも高い可読性を保つ。これにより、プレビューがなくても内容が理解しやすくなる。

4. 互換性と拡張性

   • Markdownは多くのプラットフォームやツールでサポートされており、互換性が高い。また、拡張性があり、独自のMarkdownバリアントを追加することができる。
   • さらに、HTMLやpdf、docxなどの他の形式に変換するツールも多数存在する。

5. 開発者フレンドリー

   • Markdownは開発者にとって非常に使いやすい。コードブロックのサポートや、GitHub Flavored Markdown（GFM）などの拡張記法が、技術ドキュメント作成を容易にする。

Info

より詳細に知りたい場合は、HackMDのMarkdownガイドを参照。HackMD限定の機能や記法も含まれるので注意。

まとめ

Markdownはシンプルで直感的な構文を持ち、文書を簡単に書式化するために設計されている。そのシンプルさと直感的な構文で、技術者やライター、ブロガーに広く利用されている。日常的なメモにすら使える。

Closing

次回はMarkdownを用いたサービスや拡張用法の説明を行う