mdoc
mdoc copied to clipboard
scalameta
Typechecked markdown documentation for Scala
It would be super awesome if we could import compiler plugins. eg ammonite allows ``` import $plugin.$ivy.`org.spire-math::kind-projector:0.6.3` ``` I have no idea if this is feasible or not but it...
If an evaluation is taking longer time or even not ending it's not possible currently to get the output that is being printed. For example this evaluation will never finish:...
Using mdoc 2.1.1 I'm seeing a strange interaction between `:fail` sections and later sections. E.g. if I format the following: ```scala mdoc val x = 1 ``` ```scala mdoc:fail x...
Mdoc versions affected 2.0.3/2.1.0 Sbt version 1.3.4 After migrating from tut to mdoc I found this error. The snippets are like this: ```scala mdoc val apartments: Seq[Apartment] = Seq( Apartment("Paris",...
Hope I am not overstepping my bounds here but I have a use-case that I cannot get around and this request seems to be a good way to solve it....
As per this [PR's comment](https://github.com/scalameta/mdoc/pull/191#discussion_r326923537) evaluation of lazy values could emulate what we'd get in the Scala REPL: ```scala scala> lazy val x = 42 x: Int = ```
```scala error: /Users/lgeirsson/dev/bsp/docs/bindings/java.md:34 (mdoc generated code) illegal start of simple expression val res0 = val output: OutputStream; $doc.binder(res0, 14, 0, 14, 24) ^ ```
Minimal reproduction: https://github.com/OutWatch/outwatch/tree/mdoc-exports-not-defined ``` sbt docs/mdoc --watch ``` Then open the browser, and in the console you will see: ``` readme.md.js:30 Uncaught ReferenceError: exports is not defined at readme.md.js:30 (anonymous)...
``` warning: thesis.md:9:34: warning: Unknown link 'assets/olafur.geirsson-scalafmt-thesis.pdf'. Read the 55 page glorious report [here](assets/olafur.geirsson-scalafmt-thesis.pdf). ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``` The pdf exists, but mdoc only takes into account markdown links.
Currently, code fences must have the language `scala mdoc`. However, with custom modifiers it's possible to render any syntax (JSON, markdown, ...) so it would be nice if it was...