1

最近Markdownを使っています。

Markdown に関する私の最大の問題の 1 つは、Markdown にはドキュメント内にファイルを含めるための構文がないことです (これlistingsに対して、LaTeX のパッケージとは異なります)。

Markdown を拡張して、ファイル全体および部分的なファイルをコード スニペットとして含めることをサポートしたいと考えています。たとえば、次のようになります。

![:include src/foo/bar.rb](10-20)

これにより、10 行目から 20 行目のコンテンツがブロックbar.rbとしてドキュメントに挿入されcodeます。その根拠は、

  • コードの変更に応じてドキュメントを更新できます。(vs. 常に時代遅れになるコピー アンド ペースト)
  • その後、ドキュメントにある正確なコードを単体テストできます

私の質問は次のとおりです。

  1. 構文はどうあるべきですか？
  2. これはすでに行われていますが、私はそれを見逃していますか?
4

3 に答える 3

1

私は一般的に、既存の構文を合理的な方法で使用できるようにすることができるかどうかを確認する傾向があります。現在、

    ![作例写真](http://example.com/example.jpg)

構文とその関係は、テキストに画像を含めるために使用されます。同じような調子で、

    +[一般的な見出し](http://example.com/heading.txt)

また

    +[ローカル見出し](file:///dir/a/b/c/example.txt)

テキストを含めるために使用できます。この場合、角括弧内のテキストはalt-textインライン画像の属性と同じです。これには、含まれるファイルの人間が理解できる短い説明が含まれています。

このファイルの内容をこのドキュメントに追加+することを意味します。

于 2009-10-27T21:00:08.323 に答える
0

少し遅れてごめんなさい。しかし、restructuredTextはすでにこれをサポートしています：http： //docutils.sourceforge.net/docs/ref/rst/directives.html#include-an-external-document-fragment

于 2009-11-03T19:49:56.653 に答える