Where communities thrive


  • Join over 1.5M+ people
  • Join over 100K+ communities
  • Free without limits
  • Create your own community
People
Repo info
Activity
    Mike Limansky
    @limansky
    ok :)
    Chris Stewart
    @Christewart
    has anyone had problems with mdoc and accumulating ever growing git history? Our repo takes forever to clone because it apperas things keep getting added to the docs/ folder on every merge
    1 reply
    Anton Sviridov
    @velvetbaldmime:matrix.org
    [m]
    How's your build set up? I never check in the results of mdoc generation
    Anton Sviridov
    @velvetbaldmime:matrix.org
    [m]
    mdoc itself doesn't generate html files, are you sure it's not unidoc's API files?
    also - I'm guessing you're referring to gh-pages branch?
    because mdoc doesn't check anything in either.
    Chris Stewart
    @Christewart
    It could
    Chris Stewart
    @Christewart
    Does unidoc even require it's own brancy anymore? I haven't looked at this in forever
    It seems that docusraus (which mdoc uses) is the thing publishing to the gh pages branch? https://github.com/bitcoin-s/bitcoin-s/tree/gh-pages
    Nishant Vishwakarma
    @nishantv12

    I was trying to explore mdoc in a sample project following the documentation. I have added the plugin in plugins.sbt and created two projects in build.sbt where docuemntation project depends on my root project as given in the documentation. However, when I run docs/mdoc I get error for dependency resolution as mdoc is looking for 2.12 version of the project but I am using 2.13.

    addSbtPlugin("org.scalameta" %% "sbt-mdoc" % "2.2.21")
    lazy val `sample-project` = project
      .in(file("."))
      .settings(
          name := "sample-project",
          version := "0.1",
          scalaVersion := "2.13.3"
      )
    lazy val docs = project       // new documentation project
      .in(file("myproject-docs")) // important: it must not be docs/
      .settings(
        mdocVariables := Map("VERSION" -> version.value, "SCALA_VERSION" -> "2.13.3")
      )
      .dependsOn(`sample-project`)
      .enablePlugins(MdocPlugin)

    What am I missing?

    Anton Sviridov
    @velvetbaldmime:matrix.org
    [m]
    SBT will set it to 2.12 by default
    I think you need to explicitly set scalaVersion to 2.13.13 on the docs project as well
    Tomasz Godzik
    @tgodzik
    @velvetbaldmime:matrix.org that's exactly true
    Nishant Vishwakarma
    @nishantv12
    Thanks @velvetbaldmime:matrix.org and @tgodzik.
    Nishant Vishwakarma
    @nishantv12
    Does mdoc have a feature to refer snippets from scala files? Something like snip block from paradox?
    Ólafur Páll Geirsson
    @olafurpg
    @nishantv12 there's nothing built-in, but you can implement it yourself with a custom modifier
    it would be nice to provide something like this built-in, but I didn't want to open source the implemenation in the mdoc repo because it hardcodes github
    we might need to provide a few different modifiers to accommodate different needs (link to github, just inline contents, select specific lines from the file, ...)
    instead of figuring out how to expose all that configuration it ended up being easier to ask users to roll their own implementation.
    Tomas Herman
    @tomasherman

    Hi everyone, i was wondering if anyone is using mdoc with scala3 ... im running into this issue where im trying to use scala3 syntax in mdoc but for some reason it's failing on this:

    error: /Users/tomas.herman/workspace/datadog4s/site/docs/userguide.md:180:41:
    `_` is no longer supported for a wildcard import; use `*` instead
    This construct can be rewritten automatically under -rewrite -source future-migration.
    import com.avast.datadog4s.extension.jvm.*

    Basically it's complaining about _ not being supported and forcing me to use *, which is fine ... but i'm already using *!

    Any ideas why that is?

    Anton Sviridov
    @velvetbaldmime:matrix.org
    [m]

    @tomasherman: the scala 3 support is supper new and you might be the first person to actually test it :) is this issue minimizable or at least somewhere I can take a look at a reproduction?

    I'm asking because the code generator for Scala 3 is new and different, so it may as well have problems

    Jack Koenig
    @jackkoenig
    I tend to keep burning myself by accidentally having a space between the triple backticks and scala, is there a way to warn on this?
    Ólafur Páll Geirsson
    @olafurpg
    @jackkoenig i estimate it would be easy to report a warning for this
    felher
    @felher

    Hey folks.

    Is there Mdoc-Syntax to get your input from a file? Instead of

    '''scala
    // this is inline scala content
    '''

    something like

    '''scala-from "../src/main/scala/SomeFile.scala", start:130, end:150
    '''
    Ólafur Páll Geirsson
    @olafurpg
    @felher theres a related discussion if you scroll a few messages up
    May 21st
    felher
    @felher
    @olafurpg Thanks, I'll take a look. Sorry, I just can't figure out the gitter search :)
    felher
    @felher
    @olafurpg Okay, took me a while to get how to do custom modifiers, but it now works like a charm. Thank you!
    RAJKUMAR NATARAJAN
    @rajcspsg
    Hi guys
    I'm migrating tut plugin to mdoc plugin
    I've below settings while using the tut plugin
    tutNameFilter := """.*\.(md|json|css|html)""".r
    when using mdoc plugin, I've settings as below
    mdoc / include := """.*\.(md|json|css|html)""".r
    When I run sbt docs/mdoc, I get below error

    /Users/rajkumar.natarajan/Documents/Coding/OS/reftree/build.sbt:121: error: not found: value include

    mdoc / include := """.*.(md|json|css|html)""".r,

          ^

    sbt.compiler.EvalException: Type error in expression

    what is wrong with my new settings?
    Bill Frasure
    @swoogles
    Hey Folks, are there any tips to trick Intellij into treating fenced Scala Mdoc snippets as plain Scala snippets?
    When I have plain scala in my snippets, I get syntax highlighting and autocomplete, but when I use scala mdoc... I get all the cool features of mdoc, but lose the basic Scala features in the IDE
    Ólafur Páll Geirsson
    @olafurpg
    @swoogles might be worth reporting to intellij. Syntax highlighting works in VS Code
    Bill Frasure
    @swoogles
    Thanks @olafurpg
    Bill Frasure
    @swoogles

    I've defined a format PostModifier, which is working great.

    Goal: Combine this with the Predefined Modifiers, to write snippets like
    scala mdoc:crash:format
    scala mdoc:nest:format
    or
    scala mdoc:format:crash
    scala mdoc:format:nest

    If I do format:crash, then crash is ignored, because it's just an unused parameter to my custom format PostModifier.
    If I do crash:format, then I get Invalid mode 'crash:format'

    Is there some way of saying "I want both of these behaviors, but independently, rather than trying to parse them as some combined operation" ?

    Ólafur Páll Geirsson
    @olafurpg
    @swoogles this is not supported right now but would be a cool feature
    Bill Frasure
    @swoogles
    Darn, thanks for confirming the gap!
    Would it be helpful to write up a ticket?
    Ólafur Páll Geirsson
    @olafurpg
    Sure. Although no promises about when it might get picked up by somebody
    But a ticket is a great place to consolidate discussions
    Bill Frasure
    @swoogles
    Righto, created - scalameta/mdoc#537
    If you have any tips for where in the codebase this could be implemented, I could take a crack at it :)
    I'm working on a book currently, and this feature would be beneficial enough that I could justify putting some hours towards it
    Bill Frasure
    @swoogles

    Does MDoc not support Scala 3 end markers?

    '''scala mdoc (Backticks in my actual code)
    def displayTemperature(
        behavior: String
    ): String =
      val temperature =
        try
          getTemperature(behavior)
        catch
          case (ex: RuntimeException) =>
            null
    
      "Temperature: " + temperature
    end displayTemperature
    '''

    When I execute mdoc in my project now, I get this-

    Not found: end
    end displayTemperature
    ^^^

    If I remove the end markers, the rest of the Scala 3 syntax (eg optional braces) works fine