scala - 生成 Scala API 文档，无需 JavaScript，而是静态 HTML 或 Markdown

Question

对于应用程序内帮助浏览器，我想呈现 API 文档。不幸的是，Scaladoc 似乎只生成了充满可怕 JavaScript 内容的 HTML 文件，因此即使使用诸如 SwingBox 之类的重量级组件也无法渲染这些文件。 (虽然它确实有非常好的 CSS)。

所以我的问题是:我可以利用 Scaladoc 工具或其 API(如果有的话)生成一些中间表示，然后我可以将其写入自定义 Markdown 文件或静态 HTML 页面吗？

Answer 1

您正在寻找的是自定义 Doclet实现，可以通过 -doc-generator 使用scaladoc 的命令行选项.我无法回答是否已有 Doclet实现将满足您的需求，但一个有希望探索的实现是Extradoc .但是，它已经有一段时间没有更新了。
在较低级别，您可以通过继承 Doclet 来实现您自己的。和相关的 API(例如 HTMLFactory 和 Template )。除了 Extradoc ¹ 之外，似乎没有任何/很多示例说明如何做到这一点。 .不幸的是，看起来 ScalaDoc 在这个领域没有得到与 JavaDoc 同等水平的关注。根据 these release notes , 2.12 有一个改进的 ScalaDoc 接口(interface)，但我不认为它改变了对 JavaScript 的依赖。
我也遇到了Nyandoc ，它将 ScalaDoc 和 JavaDoc 转换为 Markdown。也许作为一种直接的形式，它可以让你更接近你的目标。
这就是说，使用 JavaFX WebView 组件选项？它背后有一个成熟的 WebKit 浏览器和 JS 引擎，并且可以 embed JavaFX components in Swing .