首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >如何使用类似于mdbook的可运行代码片段编写Scala文档?

如何使用类似于mdbook的可运行代码片段编写Scala文档?
EN

Stack Overflow用户
提问于 2020-10-15 09:19:34
回答 2查看 66关注 0票数 3

Rust工具mdbook从Markdown生成文档。它允许读者直接在浏览器中编辑和运行Rust代码片段,方法是将它们通过管道传输到Rust Playground。这使您可以编写可读的文档,同时让您的读者尝试示例,而无需将其剪切并粘贴到本地编辑器中。Rust文档使用了这一点。

Scala也有类似的东西吗?Scala有一个游乐场(SCastie),所以看起来困难的部分已经解决了。也许有一个更通用的工具,比如gitbook,可以通过将SCastie配置为后端来做到这一点?

EN

回答 2

Stack Overflow用户

发布于 2020-10-15 19:25:36

Mdoc允许在您的代码之外创建SCastie代码片段。

来自文档:

之前:

代码语言:javascript
复制
```scala mdoc:scastie

val x=1+2

println(x)

代码语言:javascript
复制

之后:

代码语言:javascript
复制
<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>
票数 4
EN

Stack Overflow用户

发布于 2020-10-15 19:22:37

您可以制作scalafiddle代码片段。请参阅https://github.com/scalafiddle/scalafiddle-core/blob/master/integrations/README.md上的文档

票数 2
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/64363551

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档