2

私はPlay Framework で使用される Web ヘルプの大ファンです。理由は次のとおりです。

  • 同じ場所から任意のバージョンのドキュメントを非常に簡単に取得できます (1.0 までさかのぼります)。
  • すべてのドキュメントは同じスタイルです (1.0 ドキュメントは 2.1.0 ドキュメントと同じように見えます)
  • 読みやすい URL (他の多くの Web ヘルプ システムが使用しているように見える iframe のナンセンスはありません)

私は現在.chm、アプリケーションのドキュメントに古き良きものを使用しています。.chmドキュメントをオンラインで公開できるように、ウェブサイトへのコンバーターを作成中です。

先に進む前に、Play Framework の Web ヘルプ システムがどのように実装されているか知っている人はいますか? ソースをどこかにダウンロードすることはできますか?

4

2 に答える 2

2

プロセスは非常に簡単です。ドキュメントは Git のソース コードの近くにあるため、Git (タグ、マージ/競合) の恩恵を受けることができます。

Markdownで書かれているので簡易テキストエディタで簡単に書けます。次に、 Pegdown ライブラリを使用して HTML ファイルに変換されます。

このプロセスの例については、次のプロジェクトをご覧ください: https://github.com/ndeverge/play2-docs-renderer

Markdown ファイルを Github リポジトリから HTML ファイルにオンザフライで変換します。ここで結果を確認できます: http://play2-docs-snapshot.herokuapp.com/

于 2013-04-01T07:43:13.043 に答える