Sphinxをはじめよう 第3版

付録DMarkdownで書いてみよう

2021年現在、Markdownはとても人気のあるマークアップ言語です。GitHubをはじめとする各種Webサービスで採用されているほか、エディタやビューアなどの関連ツールの開発も活発です。その結果、多くの開発者が日々利用しています。

Sphinxはメインのマークアップ言語としてreStrucutedTextを採用していますが、Sphinx拡張を追加することであらたなマークアップ言語を扱えるようになります。ここでは、Sphinx拡張 MyST-Parser 1 を使い、Markdownで記述された原稿をSphinxで変換する方法を紹介します 2 。

1

https://myst-parser.readthedocs.io/en/latest/

2

以前はMarkdown向けのSphinx拡張としてrecommonmark (https://github.com/readthedocs/recommonmark)がよく用いられていましたが、近年メンテナンスが終了となったため、本書ではMyST-Parserを取り上げます。

D.1　Markdownの歴史

はじめに、Markdownの歴史についてひも解いていきましょう。

Markdownは2004年にJohn Gruber（ジョン・グルーバー）によって策定されました。シンプルで覚えやすい記法と、HTMLへの変換ツールの出来によって、Markdownはすぐに幅広い用途に使われるようになりました。今日では、とても多くのWebサービスやツール、ライブラリがMarkdownに対応しています。

表D-4: Markdownに対応しているおもなWebサービス

サービス名