2

我是Play Framework 使用的网络帮助的忠实粉丝。原因如下：

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

我目前正在.chm为我的应用程序文档使用 good old。我正在构建一个.chm网站转换器，以便我可以将文档放到网上。

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

4

2 回答 2

2

我认为他们使用降价，这里是帮助来源

我不知道 Play 的文档系统详细信息，无论如何，为我自己的应用程序实现类似的东西大约需要 2 个小时，使用类似于 StackOverflow (javascript) 上使用的这个“编辑器”。

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

于 2013-03-31T21:24:00.037 回答
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 回答