https://github.com/alejandrohdezma/sbt-mdoc-toc

Allows mdoc to generate table of contents for markdown files
https://github.com/alejandrohdezma/sbt-mdoc-toc

documentation mdoc scala

Last synced: 8 months ago
JSON representation

Allows mdoc to generate table of contents for markdown files

• Host: GitHub
• URL: https://github.com/alejandrohdezma/sbt-mdoc-toc
• Owner: alejandrohdezma
• License: apache-2.0
• Created: 2020-02-17T08:03:55.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-05-15T05:21:45.000Z (about 2 years ago)
• Last Synced: 2024-05-21T04:13:46.754Z (about 2 years ago)
• Topics: documentation, mdoc, scala
• Language: Scala
• Homepage:
• Size: 454 KB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# `mdoc` table-of-contents generator

This plugin enables generating a table of contents for markdown files using [`mdoc`](https://scalameta.org/mdoc/) by adding the following code:

````markdown

```scala mdoc:toc

```

````

## Installation

Add the following line to your `plugins.sbt` file:

```sbt

addSbtPlugin("com.alejandrohdezma" % "sbt-mdoc-toc" % "0.4.2")

```

## Usage

Just add the following where you want to add the table of contents in your markdown file:

````markdown

```scala mdoc:toc

```

````

And run `sbt mdoc`.