Play Framework的幫助如何實現？

我是web-help used by the Play Framework的巨大粉絲。這裏的原因：Play Framework的幫助如何實現？

很容易得到的文檔從同一個地方的任何版本的所有文檔具有相同的風格（所有回1.0的方式）
（1.0文檔看起來一樣好2.1.0文檔）
容易讀取的URL（無IFRAME廢話許多其他Web幫助系統似乎使用）

我目前使用好老.chm我的應用程序的文檔。我正在爲網站轉換器建立.chm，以便我可以將文檔聯機。

在我太過分了之前，有沒有人知道Play Framework網絡幫助系統是如何實現的？是否有可能在某處下載源代碼？

來源

2013-03-31 Ned Twigg

這個過程很簡單。他們的文檔接近Git的源代碼，所以他們可以從Git（標籤，合併/衝突）中受益。

它是用Markdown編寫的，所以很容易用簡單的文本編輯器編寫它。然後使用Pegdown library將其轉換爲HTML文件。

對於這個過程的一個例子，你可以在這個項目中來看一看：https://github.com/ndeverge/play2-docs-renderer

它把從GitHub庫到HTML文件中飛降價文件。你可以在這裏看到結果：http://play2-docs-snapshot.herokuapp.com/

來源

2013-04-01 07:43:13

我特別感興趣的是維護文檔的多個版本--1.0,1.2,1.3,2.0等。通過在Pegdown中運行markdown服務每一頁文檔似乎不必要地昂貴，但我對web dev非常陌生，也許這並不是什麼大不了的事情。（我喜歡play2-docs-renderer查看最新版本，好主意）。你碰巧知道playframework.org網站的文檔是否以每個頁面視圖的markdown形式提供？我正在計劃構建由AWS靜態託管的東西，但也許動態的東西會很好。 –

AFAIK，Play團隊在交付時生成一次靜態文檔，但我不知道他們是如何做到的。使用Pegdown來構建您的HTML文件，然後將其託管在AWS（甚至是靜態的S3）上不應該很複雜。 –

我認爲他們使用降價，here are the help sources

我不知道播放的文件系統的詳細信息，爲自己的應用程序類似反正實現的東西花了大約2小時內「編輯」類似這樣一個在StackOverflow的使用（ JavaScript的）。

您可以將示例markdownj用作Java，Pagedown用作編輯器。

來源

2013-03-31 21:24:00 biesior

感謝您的鏈接，他們是非常有益的！ –

Play Framework的幫助如何實現？

回答

相關問題