軽量マークアップ言語の比較と対照[終了]
-
20-08-2019 - |
質問
最も一般的な軽量マークアップ言語を特定し、それらの長所と短所を比較してください。これらの言語は、ドキュメントなどの技術的な散文のための汎用マークアップである必要があります(たとえば、Hamlはカウントしません)。
解決
私は、優れたプログラミングおよび技術コミュニティで一般的に使用される3つの主要な言語、Textile、Markdown、およびreStructuredTextを知っています。 3つすべては、数時間または<!> quot; winged <!> quot;で学習できます。チートシートを近くに置いてください。
テキスタイル
- RedmineおよびRubyコミュニティで使用
- スタックオーバーフローで現在タグ付けされている113の質問
- HTMLに最も似ていますが、読みにくいソース
- 3つの言語すべての最も簡単なネストされたリスト
- プログラマーでない人やHTMLを知らない人には理解できない
- 複雑な短いドキュメントに最適(リンク、ネストされたリスト、コード、カスタムHTMLを使用)。例:短いドキュメント、ハウツー、ブログ、CMSコンテンツ
- 構文リファレンス
マークダウン
- 母国語がないようです<!> quot; community <!> quot;しかし...
- Stack Overflow *でタグ付けされた1274の質問
- 電子メールの伝統と同様に、ソースコードの可読性を強調します
- 直接的なHTML埋め込み(タグを入力するだけ)
- HTMLの埋め込み以外にテーブルを作成する方法はありません
- スタックオーバーフローを知っていれば、すでに知っています
- reStructuredTextをすでに知っているかどうかを簡単に知ることができます
- <!> lt; address@example.com <!> gt;形式の自動メールアドレス難読化(山括弧付き)
- 構文リファレンス
reStructuredText(A.K.A. ReST)
- Pythonコミュニティで人気
- スタックオーバーフローでタグ付けされた285の質問
- 私に尋ねると、空白と整列について少し頑固です
- リスト(特にネストされたリスト)とパラグラフは常に争いを起こしているようです
- 非プログラマーでも読み取り可能
- 目次を作成できる形式のみ(Pythonリファレンス実装の拡張機能を使用)
- PDFやXMLなどの他の形式に直接変換する
- 散文が多い大規模なドキュメントに最適(例:ユーザーマニュアル用のdocbookの代替)
- 構文リファレンス
他のヒント
- 比較的読みやすいマークアップ
- 直接的なコマンドラインの使用
- 一部の人は、構文に関して比較的「つまらない」(柔軟性がある)と感じるかもしれません
- docbookおよび(x)html出力
軽量マークアップ言語のウィキペディアのページには、さまざまなオプションがよく比較されています一般的な用途の構文を示すもの(見出し、太字、斜体など)
ここでは、さまざまな軽量マークアップ言語をすべてカバーしようとしています。
http://www.subspacefield.org/~travis/static_blog_generators.html
ご覧のとおり、それは<!> quot;で始まりました。どうすれば安全なブログを作成できます<!> quot; -つまり、静的HTMLを生成するもので、マークアップ言語、テンプレートシステムなどに夢中になっていることに気付きました。
更新
Python実装のLWMLのみに焦点を合わせました。ここにあります:
http://www.subspacefield.org/~travis/python_lightweight_markup_languages.html
これまでのところ、マークダウンとReSTを試してみましたが、 他のページに埋め込まれたHTMLスニペット。テーブル、相互参照、間接リンクなど...
ドキュメント用?
doxygen はどうですか?
文書化する必要があるc / c ++プロジェクトのいくつかに使用しました。
doxygenの作成者がdoxygenのドキュメントに使用するように、「乱用」することもできます