https://github.com/scalameta/mdoc

Typechecked markdown documentation for Scala
https://github.com/scalameta/mdoc

Last synced: 7 months ago
JSON representation

Typechecked markdown documentation for Scala

• Host: GitHub
• URL: https://github.com/scalameta/mdoc
• Owner: scalameta
• License: apache-2.0
• Created: 2017-10-23T07:00:47.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2025-04-26T06:53:25.000Z (7 months ago)
• Last Synced: 2025-04-26T07:30:47.594Z (7 months ago)
• Language: Scala
• Homepage: https://scalameta.org/mdoc/
• Size: 6.44 MB
• Stars: 399
• Watchers: 10
• Forks: 84
• Open Issues: 61
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

• fucking-awesome-scala - mdoc - activity/y/scalameta/mdoc) (Table of Contents / Sbt plugins)
• awesome-scala - mdoc ★ 94 ⧗ 0 - Typechecked markdown documentation for Scala [https://scalameta.org/mdoc/](https://scalameta.org/mdoc/) (Sbt plugins)
• awesome-scala - mdoc - activity/y/scalameta/mdoc) (Table of Contents / Sbt plugins)

README

          
# mdoc - typechecked markdown documentation for Scala

[![CI](https://github.com/scalameta/mdoc/actions/workflows/ci.yml/badge.svg)](https://github.com/scalameta/mdoc/actions/workflows/ci.yml)

[![Join the chat at https://gitter.im/scalameta/mdoc](https://badges.gitter.im/scalameta/mdoc.svg)](https://gitter.im/scalameta/mdoc)

![Maven Central](https://img.shields.io/maven-central/v/org.scalameta/mdoc_2.13)

mdoc is a markdown documentation tool for Scala inspired by

[tut](https://github.com/tpolecat/tut). Visit https://scalameta.org/mdoc to

learn more about mdoc.

## JDK compatibility

| JDK  | Release        |

| ---- | ---------------|

| 8    | Up to `v2.6.1` |

| 11+  | _latest_       |