metabrowse
mdoc
| metabrowse | mdoc | |
|---|---|---|
| 1 | 4 | |
| 107 | 394 | |
| 1.9% | 0.5% | |
| 8.0 | 8.6 | |
| 20 days ago | 17 days ago | |
| Scala | Scala | |
| Apache License 2.0 | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
metabrowse
-
The future of Scaladoc
I would prefer to have a mega documentation website like javadoc.io that works with an engine like metabrowse. I often find myself cloning various FOOS libraries to browse their codebase and grep things.
mdoc
- Optimal decision-making with examples built using scala
-
Friction-less scala - Tell us what is causing friction in your day-to-day life with Scala
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
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
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
What are some alternatives?
scastie - An interactive playground for Scala
sbt-unidoc - sbt plugin to create a unified Scaladoc or Javadoc API document across multiple subprojects.
ducktape - Automatic and customizable compile time transformations between similar case classes and sealed traits/enums, essentially a thing that glues your code. Scala 3 only. Or is it duct 🤔
sbt-mima-plugin - A tool for catching binary incompatibility in Scala
Scalafix - Refactoring and linting tool for Scala
sbt-revolver - An SBT plugin for dangerously fast development turnaround in Scala
Squid - Squid – type-safe metaprogramming and compilation framework for Scala
sbt-pack - A sbt plugin for creating distributable Scala packages.
sbt-updates - sbt plugin that can check Maven and Ivy repositories for dependency updates
sbt-microsites - An sbt plugin to create awesome microsites for your project
coursier - Pure Scala Artifact Fetching
sbt-docker - Create Docker images directly from sbt