# mdoc

Markdown documentation tool for Scala that compiles and evaluates the Scala code blocks in markdown sources.


Source: https://findsoftware.frbit.cloud/mdoc/
Last reviewed: 2026-10-23
Listed since: 2026-10-23

## Record

### Links

- home: https://scalameta.org/mdoc/
- repository: https://github.com/scalameta/mdoc
- docs: https://scalameta.org/mdoc/docs/installation.html
- discord: https://discord.gg/FN9uG7k

### Identity

- status: active
- maintainer: mdoc developers
- maintainerType: community
- parent: unknown
- firstRelease: 2018
- hqCountry: unknown

### Kind

- category: ssg
- hosting: unknown
- language: scala
- runtime: jvm
- runtimeMin: jvm 11
- basedOn: unknown

### Content

- contentStore: unknown
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: unknown
- i18n: unknown

### Rendering and deploy

- runsAs: local
- renderingModes: unknown
- installMethod: sbt plugin sbt-mdoc

### License

- licenseModel: open-source
- license: Apache-2.0

### Releases

- currentMajor: 2
- latestReleaseDate: 2026-09-03

### Adoption

- githubStargazers: 402
- packagistDownloads: not applicable
- npmWeeklyDownloads: not applicable
- contributors: 52
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: unknown
- dependentPackages: unknown

### Sources

- urls: https://scalameta.org/mdoc/ (read 2026-10-23)
- urls: https://api.github.com/repos/scalameta/mdoc (read 2026-10-23)
- urls: https://scalameta.org/mdoc/docs/installation.html (read 2026-10-23)
- maintainer: https://scalameta.org/mdoc/ (read 2026-10-23)
- category: https://github.com/scalameta/mdoc/blob/main/readme.md (read 2026-10-23)
- runtime: https://github.com/scalameta/mdoc/blob/main/readme.md (read 2026-10-23)
- runtimeMin: https://github.com/scalameta/mdoc/blob/main/readme.md (read 2026-10-23)
- installMethod: https://scalameta.org/mdoc/docs/installation.html (read 2026-10-23)
- installMethod: https://scalameta.org/mdoc/docs/installation.html (read 2026-10-23)
- installMethod: https://scalameta.org/mdoc/docs/installation.html (read 2026-10-23)
- license: https://api.github.com/repos/scalameta/mdoc (read 2026-10-23)
- license: https://github.com/scalameta/mdoc/blob/main/LICENCE.md (read 2026-10-23)
- licenseModel: https://github.com/scalameta/mdoc/blob/main/LICENCE.md (read 2026-10-23)
- currentMajor: https://api.github.com/repos/scalameta/mdoc/releases/latest (read 2026-10-23)
- latestReleaseDate: https://api.github.com/repos/scalameta/mdoc/releases/latest (read 2026-10-23)
- firstRelease: https://api.github.com/repos/scalameta/mdoc/releases?per_page=100 (read 2026-10-23)
- githubStargazers: https://api.github.com/repos/scalameta/mdoc (read 2026-10-23)
- contributors: https://api.github.com/repos/scalameta/mdoc/contributors?per_page=1 (read 2026-10-23)
- runsAs: https://scalameta.org/mdoc/docs/installation.html (read 2026-10-23)
- language: https://api.github.com/repos/scalameta/mdoc (read 2026-10-23)

## Notes

mdoc is a markdown documentation tool for Scala. It reads markdown sources, compiles and evaluates the Scala code blocks in them, and writes markdown in which each block shows its result, so the examples in the documentation are type-checked. It runs as the sbt-mdoc plugin in an sbt build, where the docs/mdoc task generates the documentation, from the command line through coursier, or as a library API. The project is maintained by the mdoc developers. A [migration guide](https://scalameta.org/mdoc/docs/tut.html) covers moving documentation over from tut.

## Worth knowing

mdoc writes markdown. Its DocusaurusPlugin builds a static site from that markdown with Docusaurus, which needs node and yarn. The JDK requirement differs between releases, as the README's compatibility table shows.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0