生成不含JavaScript的Scala API文档，但是静态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那样得到同样的关注。根据{{​​3}}，2.12有一个改进的ScalaDoc接口，但我认为它不会改变对JavaScript的依赖。

我还遇到了these release notes，它将ScalaDoc和JavaDoc转换为Markdown。也许作为一种直接的格式，它可以让你更接近你的目标。

所有这一切，是使用JavaFX Nyandoc组件吗？它有一个完整的WebKit浏览器和JS引擎，它可以WebView。