RST から MD への変換方法
- .RST ファイルを追加してください。上のボックスにドロップするか、クリックしてブラウズします。
- 数秒で .MD に変換されます。
- 新しい .MD ファイルをダウンロードしてください。
期待される結果
- 見出し、箇条書きリスト、リンク、インラインコードはきれいに変換されますが、RSTディレクティブ(
.. note::、.. code-block::)やロール(:ref:、:func:)は削除または近似されるため、変換後にすべてのディレクティブを確認してください。 .. toctree::は保持されません。変換後に手動で目次を再構築する必要があります。- 特定のMarkdownフレーバーをターゲットにするには、Pandocに
-t gfm(GitHub Flavored Markdown) または-t commonmarkを渡します。
よくある質問
RSTからMarkdownへの変換はロスレス(無劣化)ですか?
いいえ。見出し、リスト、リンク、インラインコードなどの基本的なコンテンツは引き継がれますが、RSTのディレクティブやロールにはMarkdownに対応するものがなく、失われます。手動での修正が必要になるのが一般的です。
RSTとMarkdownの主な違いは何ですか?
どちらもプレーンテキストのマークアップ言語ですが、RSTは構造化ドキュメント(Sphinx)向けに設計された豊富なディレクティブとロールのシステムを持っています。Markdownはよりシンプルで、READMEや一般的なメモに広く使用されています。
RSTファイルのフォルダ全体を一括変換するにはどうすればよいですか?
Pandocは1コマンドにつき1ファイルを処理します。LinuxまたはmacOSでは、
for f in *.rst; do pandoc "$f" -o "${f%.rst}.md"; done のようにループ処理を行ってください。Markdownに変換した後もSphinxドキュメントを機能させ続けるには?
通常のMarkdownの代わりに MyST Markdown を使用してください。MySTはRSTスタイルのディレクティブとロールをサポートしているため、Sphinxのビルドを継続して機能させることができます。