Markdownの拡張用法

Intro

Markdownはそのシンプルさと拡張性から、多くのツールやサービスで利用されているが、さらに機能を拡張するためのさまざまな拡張機能も存在する。以下にいくつかの主要なMarkdown拡張とその用途、便利さを使用ケースを交えて説明する。

TL; DR

Markdownの拡張機能は、視覚的な情報の共有、数式の埋め込み、プレゼンテーション資料の作成、コードのシンタックスハイライトなど、多岐にわたる用途で利用されている。これらの拡張機能を活用することで、Markdownの基本的な機能を超えて、よりリッチで表現力の高い文書を作成することができる。

• Mermaid
• Marp
• MathJax
• PlantUML
• Syntax Highlighting
• Footnotes
• Embedded Content
• まとめ

Mermaid

Mermaidは、Markdownにフローチャートやシーケンス図、ガントチャートなどのダイアグラムを追加するための拡張機能だ。テキストベースでダイアグラムを記述できるため、視覚的な情報を簡単に作成・共有できる。

• 用途: フローチャート、シーケンス図、ガントチャートなどのダイアグラム作成
• 便利さ: コードレビューやプロジェクト計画、システム設計など、視覚的な情報を簡単に共有できる
• 使用ケース:

  graph TD;
  A-->B;
  A-->C;
  B-->D;
  C-->D;

Info

導入のために参照 (scripts.jsxでmermaid.js読み込み): https://ganzhixiong.com/p/7b057616/

Marp

Marpは、Markdownファイルを使ってプレゼンテーション資料を作成するためのツールだ。スライド形式でMarkdownを記述し、簡単にプレゼンテーションを作成できる。

• 用途: プレゼンテーション資料の作成
• 便利さ: 普段使い慣れたMarkdownでスライドを作成できるため、学習コストが低い
• 使用ケース:

  ---
  title: Markdown Presentation
  ---
  
  # スライド1
  内容
  
  ---
  # スライド2
  内容

MathJax

MathJaxは、Markdownに数式を埋め込むための拡張機能だ。LaTeX形式で数式や特殊記号を由緒正しい形式で記述できるため、工学的あるいは理論的に非常に便利である。

• 用途: 数式の埋め込み
• 便利さ: 複雑な数式や科学技術文書を簡単に記述できる
• 使用ケース:

  $$E = mc^2$$

$$E = mc^2$$

Info

導入のために参照 (scripts.jsxでMathJax.js読み込み): https://github.com/ppoffice/hexo-theme-icarus/issues/511

PlantUML

PlantUMLは、MarkdownにUMLダイアグラムを追加するための拡張機能だ。UMLを使って設計図やシステムアーキテクチャを視覚的に表現できる。

• 用途: UMLダイアグラムの作成
• 便利さ: ソフトウェア設計やシステムアーキテクチャの可視化に役立つ
• 使用ケース:

\{% plantuml %}@startuml
Alice -> Bob: Request
Bob --> Alice: Response
@enduml
\{% endplantuml %}

Syntax Highlighting

コードブロックにシンタックスハイライトを適用するための拡張機能だ。プログラミング言語ごとに色分けされるため、コードの可読性が向上する。色遣いはCSSで指定できる。

• 用途: コードのシンタックスハイライト
• 便利さ: コードレビューや技術文書でのコード共有が容易になる
• 使用ケース:

python

def hello_world():
    print("Hello, World!")

Footnotes

フットノートを追加するための拡張機能だ。詳細な説明や参考文献を簡単に記述できる。

• 用途: フットノートの追加
• 便利さ: 文書の補足情報や参考文献を簡単に追加できる
• 使用ケース:

これは例です1。

/[^1/]: これはフットノートです。

これは例です¹。

Embedded Content

YouTubeやVimeoの動画、Instagrmの投稿など、外部コンテンツを埋め込むための拡張機能だ。

• 用途: 外部コンテンツの埋め込み
• 便利さ: 動画や投稿などを文書内に直接表示できる
• 使用ケース:

{% youtube sXu9QLRb_sI %}

まとめ

Markdownの拡張用法は、視覚的な情報の共有、数式の埋め込み、プレゼンテーション資料の作成、コードのシンタックスハイライトなど、多岐にわたる用途で利用されている。これらの拡張機能を活用することで、Markdownの基本的な機能を超えて、よりリッチで表現力の高い文書を作成することができる。

Closing

しかもここに来ても、plain textの見通しのよさと管理のしやすさは継続している

---

1. 1.これはフットノートです。↩