2016-05-30 8 views
0

簡単に整備可能で、見栄えがよく、pdfおよびhtml 5形式のドキュメントを変更する必要があります。ソース形式は簡単に編集できなければなりません。このMavenプラグインは、私の会社のorganisiation theam(フォント、色、写真など)、TOC生成、別々のファイルでの章の分離、イメージファイルの統合、ドキュメントにコードスニペットを入れるための簡単な方法をサポートする必要があります。私はMavenをビルドしていますが、現在のベストディシジョンは何ですか? - 入力フォーマットとしてMD(値下げ)を用いMavenを使用したユーザーガイドのドキュメントを作成

  • Doxia

    は私の2つのオプションを検討しました。 WSWG mdフリー エディタがあり、上記のようなものをたくさんサポートしています。アーティファクトの外部レポが必要です。

  • Asciidoctor - 入力形式としてasdcii docを使用します。フラグメントなどを使用したテンプレートのサポート

このプラグインの利点と欠点は何ですか? 他にも良い解決策がありますか?

答えて

0

最初にDoxiaでドキュメントを作成してからAsciiDocと書いてみたところ、Asciidocが優れていることに気付きました。それは可能です

  • yamlファイルを使用して簡単にスタイリング。 Defaultスタイリングもとても良いです。
  • マークアップ言語としてAsciidocは、文書化さ非常に良いです:Uder Guide AsciiDoc
  • が良いオンラインeditorsを持っており、言語は例えば値下げよりも強力で、かつ容易にXML形式に比べて書き込みをします。 examples良い
  • configurationsを理解するためにMavenとASCIIドキュメントと簡単に使用します。
関連する問題