Releases: scalameta/mdoc
Releases · scalameta/mdoc
mdoc v2.0.2
What’s Changed
Note, this release is only relevant for Metals, see scalameta/metals#1069
mdoc v2.0.1
mdoc v2.0.0
Reveal.js support in HTML files
It's now possible to run mdoc on both *.md
and *.html
files. This makes it possible to use mdoc when writing slides with Reveal.js in HTML files, a common use-case that was supported by tut but not in mdoc until now.
Support for any markdown flavor
Mdoc should now work with any flavor of markdown. Previously, mdoc only supported Commonmark and custom syntax like Jekyll {toc}
, sbt-paradox, footnotes, and other markdown dialects would not be preserved. Now, mdoc only processes code fences and leaves the rest of the document unchanged.
The only syntax that is processed by mdoc is code fences using this syntax
```scala mdoc
```
and site variables using this syntax @VERSION@
.
Breaking changes
- Code fences are now by default wrapped in classes instead of objects, see #190. This means that code examples using
extends AnyVal
will result in a compiler warning. If you get the following errors when upgrading, add themdoc:reset-object
modifier to the enclosing code fence
Value class may not be a member of another class
The outer reference in this type test cannot be checked at run time.
- It's no longer possible to reference site variables using the syntax
![VERSION]
. Use@VERSION@
instead. This syntax was never documented on the website and it's no longer possible to support it with the new custom parser for Markdown code fences. The@VERSION@
syntax is more flexible since it works anywhere, including code fences, while the![VERSION]
syntax only worked in places where it was possible to write markdown links.
mdoc v1.4.0-RC2
- #198 use custom parser for markdown processing. This should make it possible to use mdoc with reveal.js slides
Mdoc v1.3.6
Mdoc v1.3.2
- #156 Support Scala 2.13 and cross-build against Scala 2.12.9
mdoc v1.3.1
- #170 Make
println
capture output from all threads - #169 When using --verbose, the mdoc instrumented source code is now printed for education purposes and to help troubleshoot issues.
- #168 The compiler is not reset on every compilation to help prevent cryptic errors like
Bad superClass for class
orencountered unrecoverable cycle resolving import
mdoc v1.3.0
mdoc v1.2.10
Identical to v1.2.9, which failed to release.