scala - 如何使用类似于 mdbook 的可运行片段编写 Scala 文档？

Question

Rust 工具 mdbook 从 Markdown 生成文档。它允许读者直接在浏览器中编辑和运行 Rust 片段，方法是将它们传送到 Rust Playground。这使您可以编写可读文档，同时让您的读者无需剪切并粘贴到本地编辑器中即可试用示例。 Rust 文档使用它。

Scala 有这样的东西吗？ Scala 有一个 Playground (SCastie)，所以看起来困难的部分已经解决了。也许有一个更通用的工具，如 gitbook，可以通过将 SCastie 配置为后端来完成此操作？

Answer 1

Mdoc允许从您的代码中创建 SCastie 片段。

来自文档:

之前:

```scala mdoc:scastie
val x = 1 + 2
println(x)
```

之后:

<script src="https://scastie.scala-lang.org/embedded.js"></script>
<pre class='scastie-snippet-2bc0b4f2-db76-4c68-8e7f-3a472d59c50d'></pre>
<script>window.addEventListener('load', function() {
 scastie.Embedded('.scastie-snippet-2bc0b4f2-db76-4c68-8e7f-3a472d59c50d', {
   code: `val x = 1 + 2
println(x)`,
   theme: 'light',
    isWorksheetMode: true,
    targetType: 'jvm',
    scalaVersion: '2.12.6'
  })
})</script>