Mdoc Alternatives

mdoc reviews and mentions

• Optimal decision-making with examples built using scala
  4 projects | /r/scala | 20 Apr 2022
• Friction-less scala - Tell us what is causing friction in your day-to-day life with Scala
  14 projects | /r/scala | 10 Aug 2021

  Literally what scaladoc is, it comes with sbt. Although, it's better when enhanced with mdoc so that you get the standard microsite template like these. It would be nice to have an sbt serveDocs and if everyone would host their docs for external linking, but javadoc doesn't do that either.

• A Scala rant
  9 projects | /r/scala | 31 Mar 2021

  The good news is that scaladoc is produced by default by sbt and published by default. So you can often pull it from the same repository your library jar came from, extract it with zip, and read the docs. But that's also totally unnecessary - javadoc.io allows you to put in your module info and serves the docs for you, so if there's an older version you can access the documentation this way. Rely on the type signatures, since they can't lie, whilst comments (including scaladoc comments) can. Honestly, library authors should be using mdoc and including examples on every public method, and that type of documentation is something you can almost always contribute to a project for a quick pr kudos.

• The future of Scaladoc
  3 projects | /r/scala | 8 Mar 2021

  I know it's not new but the "Snippet validation and results (mdoc)" features in mdoc are so cool. Really takes some of the tedium out of working with documentation since you can know that as you evolve your code the compiler will make sure you keep the docs in sync. Whole new level of Readme-Driven Development

• A note from our sponsor - SaaSHub
  www.saashub.com | 14 Oct 2024

  SaaSHub helps you find the best software and product alternatives Learn more →