Releases: scalameta/mdoc
mdoc v2.2.1
What’s Changed
- Support GIT_DEPLOY_KEY as alternative to GITHUB_DEPLOY_KEY (#352) @olafurpg
- Remove usage of fuzzywuzzy library. (#351) @olafurpg
- Add support for adding library dependencies via imports. (#333) @olafurpg
- Target a single file for
--in
and--out
(#322) @ckipp01 - Fix heading for 'command-line' (#300) @Jentsch
- Add new mdoc:warn modifier. (#308) @olafurpg
Other
- Add in maven-central badge (#320) @ckipp01
- Ignore metals specific files, bump scala213 to 2.13.2 (#334) @kpbochenek
- Upgrade dependencies (#307) @olafurpg
- Update to latest flexmark (#348) @ckipp01
- Update munit to 0.7.7 (#342) @scala-steward
- Update undertow-core to 2.1.1.Final (#339) @scala-steward
- Update directory-watcher to 0.9.10 (#338) @scala-steward
- Update undertow-core to 2.1.0.Final (#328) @scala-steward
- Update metaconfig-typesafe-config to 0.9.10 (#325) @scala-steward
- Update sbt-ci-release to 1.5.3 (#326) @scala-steward
- Update sbt, scripted-plugin to 1.3.10 (#330) @scala-steward
- Update scalameta, testkit to 4.3.10 (#332) @scala-steward
- Update munit to 0.7.1 (#319) @scala-steward
- Update xnio-nio to 3.8.0.Final (#314) @scala-steward
- Update metaconfig-typesafe-config to 0.9.9 (#312) @scala-steward
- Add in scala steward conf (#310) @ckipp01
- Update munit to 0.6.0 (#316) @scala-steward
mdoc v2.1.4
- #306 Make
fail
modifier work together withnest
mdoc v2.1.2
mdoc v2.1.0
What’s Changed
- Introduce new
mdoc:nest
modifier for redefining variables. Documentation https://scalameta.org/mdoc/docs/modifiers.html#nest (#251) @olafurpg
Tips for moving from tut to mdoc
Check out this post on migrating from tut to mdoc https://underscore.io/blog/posts/2019/12/12/tut-to-mdoc.html
Internal updates
- Update scalacheck to 1.14.3 (#247) @scala-steward
- Update fs2-core to 2.1.0 (#237) @scala-steward
- Update xnio-nio to 3.7.7.Final (#241) @scala-steward
- Update directory-watcher to 0.9.6 (#240) @scala-steward
- Update scalafmt-core to 2.3.2 (#242) @scala-steward
- Update scalajs-dom to 0.9.8 (#228) @scala-steward
- Update undertow-core to 2.0.28.Final (#222) @scala-steward
- Update fuzzywuzzy to 1.2.0 (#223) @scala-steward
- Update slf4j-api to 1.8.0-beta4 (#232) @scala-steward
- Update scalacheck to 1.14.2 (#233) @scala-steward
- Update sbt-scalajs, scalajs-compiler, ... to 0.6.31 (#227) @scala-steward
- Update scalameta, testkit to 4.3.0 (#231) @scala-steward
- Enable GitHub Actions (#236) @olafurpg
- Update jsoup to 1.12.1 (#226) @scala-steward
- Update org.eclipse.lsp4j to 0.8.1 (#224) @scala-steward
- Update xnio-nio to 3.6.9.Final (#225) @scala-steward
- Update evilplot to 0.6.3 (#216) @scala-steward
- Update directory-watcher to 0.8.3 (#221) @scala-steward
- Update flexmark-all to 0.40.34 (#219) @scala-steward
- Update sbt-assembly to 0.14.10 (#217) @scala-steward
- Update fs2-core to 1.1.0-M2 (#215) @scala-steward
mdoc v2.0.3
What’s Changed
- Rendering worksheets fixed (#211) @alekseiAlefirov
- Upgrade Scalameta dependency (#209) @olafurpg
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