如何实现Play Framework的帮助？

Question

我是web-help used by the Play Framework的粉丝。原因如下：

• 很容易从同一个地方获取任何版本的文档（一直回到1.0）
• 所有文档都具有相同的样式（1.0文档看起来和2.1.0文档一样好）
• 易于阅读的网址（许多其他网络帮助系统似乎没有使用iframe废话）

我目前正在使用旧版.chm作为我的应用程序文档。我正在构建一个.chm网站转换器，以便我可以在线提交文档。

在我走得太远之前，是否有人知道如何实施Play Framework Web帮助系统？是否可以在某处下载源代码？

Answer 1

我认为他们使用了markdown，here are the help sources

我不知道Play的文档系统细节，无论如何实现类似于我自己的应用程序的东西花了大约2个小时的“编辑器”类似于StackOverflow（javascript）上使用的那个。

您可以使用示例markdownj lib for Java和Pagedown作为编辑器。

Answer 2

这个过程非常简单。他们的文档靠近Git中的源代码，因此他们可以从Git（标记，合并/冲突）中受益。

它是用Markdown编写的，所以用简单的文本编辑器编写它很容易。然后使用Pegdown library将其转换为HTML文件。

有关此过程的示例，您可以查看此项目：https://github.com/ndeverge/play2-docs-renderer

它将Markdown文件从Github repo转换为HTML文件。 您可以在此处查看结果：http://play2-docs-snapshot.herokuapp.com/