我是 web-help used by the Play Framework 的 super 粉丝。原因如下:
- 非常容易从同一位置获取任何版本的文档(一直到 1.0)
- 所有文档都具有相同的风格(1.0 文档看起来与 2.1.0 文档一样好)
- 易于阅读的网址(没有许多其他网络帮助系统似乎使用的 iframe 废话)
我目前正在使用旧的 .chm 作为我的应用程序文档。我正在构建一个 .chm 到网站转换器，以便我可以将文档放在网上。
在我深入之前，有谁知道 Play Framework Web 帮助系统是如何实现的？可以在某处下载源吗？
最佳答案
这个过程非常简单。他们的文档靠近 Git 中的源代码，因此他们可以从 Git 中受益(标签、合并/冲突)。
它是用 Markdown 编写的，因此使用简单的文本编辑器很容易编写。然后使用 Pegdown library 将其转换为 HTML 文件。 .
有关此过程的示例，您可以查看此项目:https://github.com/ndeverge/play2-docs-renderer
它将 Markdown 文件从 Github 存储库即时转换为 HTML 文件。 您可以在此处查看结果:http://play2-docs-snapshot.herokuapp.com/
关于playframework - Play Framework 的帮助是如何实现的？，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/15734414/