Skip to content

Releases: scalameta/mdoc

mdoc v2.2.1

03 Jun 11:35
fbaa078
Compare
Choose a tag to compare

What’s Changed

Other

mdoc v2.1.4

16 Mar 14:54
8156763
Compare
Choose a tag to compare
  • #306 Make fail modifier work together with nest

mdoc v2.1.2

12 Mar 15:40
Compare
Choose a tag to compare
  • #304 Catch fatal exceptions
  • #303 Improve cli --help documentation
  • #302 Improve mdoc:js installation docs

mdoc v2.1.0

26 Dec 23:08
e642727
Compare
Choose a tag to compare

What’s Changed

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

mdoc v2.0.3

03 Dec 15:11
3afbd52
Compare
Choose a tag to compare

What’s Changed

mdoc v2.0.2

17 Nov 05:08
f6ffa2d
Compare
Choose a tag to compare

What’s Changed

Note, this release is only relevant for Metals, see scalameta/metals#1069

mdoc v2.0.1

13 Nov 00:38
fed7c5d
Compare
Choose a tag to compare

What’s Changed

mdoc v2.0.0

02 Nov 12:47
57a2770
Compare
Choose a tag to compare

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 the mdoc: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

30 Oct 16:05
Compare
Choose a tag to compare
mdoc v1.4.0-RC2 Pre-release
Pre-release
  • #198 use custom parser for markdown processing. This should make it possible to use mdoc with reveal.js slides

Mdoc v1.3.6

15 Oct 09:21
a9529f2
Compare
Choose a tag to compare