mdoc

mdoc

  • Docs
  • Blog
  • GitHub

›Recent Posts

Recent Posts

  • Fast typechecked markdown documentation with clear error messages
  • mdoc v1.3.0
  • mdoc v1.2.4
  • mdoc v1.1.1
  • mdoc v1.1.0

mdoc v1.1.1

January 1, 2019

Ólafur Páll Geirsson

Ólafur Páll Geirsson

Fix timeout issue with blocking Futures

Scala 2.12 introduced a regression that caused asynchronous code to hang forever in object constructors, see scala-dev/#195. This caused mdoc issues like #124, where futures would timeout. To workaround this problem, mdoc now uses the compiler option -Ydelambdafy:inline by default.

New --no-link-hygiene option

Use the command-line argument --no-link-hygiene to disable link hygiene so that warnings are not reported. With sbt-mdoc, add

mdocExtraArguments := List("--no-link-hygiene")

Markdown footnotes now work

Previously, markdown footnotes would render incorrectly, which has now been fixed so it's possible to write like below.

Paragraph with a footnote reference[^1]

[^1]: Footnote text added at the bottom of the document

Improved stack traces

Previously, exceptions with causes were printed with full stack traces. Now, all exception stacktraces are trimmed to only show relevant parts.

Recent Posts
  • Fix timeout issue with blocking Futures
  • New --no-link-hygiene option
  • Markdown footnotes now work
  • Improved stack traces
mdoc
Docs
Get started
Community
Chat on Gitter
More
GitHub
Copyright © 2025 mdoc developers