sbt-microsites
An sbt plugin to create awesome microsites for your project (by 47degrees)
mdoc
Typechecked markdown documentation for Scala (by scalameta)
sbt-microsites | mdoc | |
---|---|---|
1 | 4 | |
321 | 396 | |
0.3% | 0.3% | |
4.6 | 8.6 | |
5 days ago | 7 days ago | |
SCSS | Scala | |
Apache License 2.0 | Apache License 2.0 |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
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.
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.
sbt-microsites
Posts with mentions or reviews of sbt-microsites.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2021-08-10.
mdoc
Posts with mentions or reviews of mdoc.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2022-04-20.
- 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?
When comparing sbt-microsites and mdoc you can also consider the following projects:
sbteclipse - Plugin for sbt to create Eclipse project definitions
sbt-mima-plugin - A tool for catching binary incompatibility in Scala
sbt-unidoc - sbt plugin to create a unified Scaladoc or Javadoc API document across multiple subprojects.
sbt-doctest - Doctest for scala
sbt-revolver - An SBT plugin for dangerously fast development turnaround in Scala
sbt-updates - sbt plugin that can check Maven and Ivy repositories for dependency updates
sbt-header - sbt-header is an sbt plugin for creating file headers, e.g. copyright headers
sbt-pack - A sbt plugin for creating distributable Scala packages.
sbt-dependency-graph - sbt plugin to create a dependency graph for your project
coursier - Pure Scala Artifact Fetching
sbt-microsites vs sbteclipse
mdoc vs sbt-mima-plugin
sbt-microsites vs sbt-mima-plugin
mdoc vs sbt-unidoc
sbt-microsites vs sbt-doctest
mdoc vs sbt-revolver
sbt-microsites vs sbt-revolver
mdoc vs sbt-updates
sbt-microsites vs sbt-header
mdoc vs sbt-pack
sbt-microsites vs sbt-dependency-graph
mdoc vs coursier