tut is deprecated. Please switch to mdoc. See the migration guide.
tut is a very simple documentation tool for Scala that reads Markdown files and interprets Scala code in
tut sheds, allowing you to write documentation that is typechecked and run as part of your build.
The current version is 0.6.13 for sbt 1.1 and Scala 2.10/11/12/13 (2.13.0).
tut is a Typelevel project. This means we embrace pure, typeful, functional programming, and provide a safe and friendly environment for teaching, learning, and contributing as described in the Scala Code of Conduct.
1. Add the following to
addSbtPlugin("org.tpolecat" % "tut-plugin" % "0.6.13")
2. And add the following to
3. Write a tutorial in
Here is how you add numbers: ```tut 1 + 1 ```
4. At the
sbt> prompt type
tut, then look at the output in
Here is how you add numbers: ```scala scala> 1 + 1 res0: Int = 2 ```