MarkdownをreStructuredTextに変換

Markdownの文書構造を、PythonやSphinxのドキュメントで使われるreStructuredTextへ変換します。変換後の.rstは編集して仕上げられます。

Markdown入力

113 文字

RSTプレビュー

変換後のテキスト
プロジェクトノート
=========

読みやすい文書は、**分かりやすい構造**から始まります。

確認すること
------

* 見出しの階層
* 正しく開くリンク
* 再利用しやすいファイル

    ダウンロード前にプレビューを確認します。
ファイルはこのブラウザタブ内で処理されます。

MarkdownをRSTへ変換する手順

見出しの下線幅やディレクティブは、最終ビルド環境でも確認します。

01

原稿を追加

Markdownを貼り付けるか、.mdファイルを開きます。

02

RSTソースを確認

見出し、リンク、リスト、コードブロックの記法を確認します。

03

保存してビルド

.rstをダウンロードし、Sphinxなど目的の処理系で警告を確認します。

対応内容

Markdownの構造をRST記法へ

一般的な要素を、reStructuredTextで読めるソースに置き換えます。

見出しを下線記法へ各レベルの見出しをRSTのセクション表現へ変換します。
リストとリンク箇条書き、番号付きリスト、外部リンクを対応する記法へ移します。
コードブロックコードをRSTで扱えるブロックとして出力し、後から言語指定を調整できます。
活用例

RSTが必要な文書

Sphinxサイト

READMEや既存ガイドをPythonプロジェクトのドキュメントへ取り込みます。

パッケージ説明

Markdownで用意した内容をRST指定の公開環境へ合わせます。

既存資産の統一

複数記法で残った手順書をRSTベースへ集約する下準備にします。

よくある質問

MarkdownからRSTへの変換について

Sphinxのディレクティブも作られますか?

Markdownに対応情報がない場合、toctreeやautodocなどのディレクティブは自動生成しません。

変換後すぐ公開できますか?

まずSphinxなどでビルドし、見出し、リンク、表の警告を確認してください。

MarkdownのHTMLブロックはどうなりますか?

RSTに直接対応しないHTMLは、内容の簡略化やrawディレクティブへの手直しが必要です。