1. ホーム
  2. python

[解決済み] MarkdownとreStructuredTextの両方で同じREADMEを持つことができます。

2022-08-26 16:08:40

質問

私はGitHubでホストされているプロジェクトを持っています。このために、私はGitHub上できれいにフォーマットされるように、Markdown構文を使用してREADMEを書きました。

私のプロジェクトはPythonで書かれているので、私はまた、それを PyPi . PyPiのREADMEに使われる構文はreStructuredTextです。

ほぼ同じ内容を含む2つのREADMEを扱う必要がないようにしたいので、markdownからRST(またはその逆)へのトランスレータを探しましたが、見つかりませんでした。

私が見た他の解決策は、markdown/HTML を実行し、次に HTML/RST 翻訳を行うことです。このためのリソースをいくつか見つけました。 ここで はこちら となっているので、可能なのでしょう。

私がやりたいことにもっと合うアイデアはないでしょうか?

どのように解決するのですか?

私がお勧めするのは パンドック は、あるマークアップ形式から別の形式にファイルを変換するためのスイスの軍刀です(ページの一番下にあるサポートされている変換の図を見てください。) PandocはmarkdownからreStructuredTextへの直接の変換を可能にします。また、オンライン・エディタもあります はこちらです。 があり、試用することができますので、オンライン・エディタを使ってREADMEファイルを変換するだけでもよいでしょう。