Skip to content

Utility for generating table of contents for markdown files

License

Notifications You must be signed in to change notification settings

essentialkaos/mdtoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Codacy badge GitHub Actions CI Status GitHub Actions CodeQL Status

InstallationUsageCI StatusContributingLicense


mdtoc is simple utility for generating table of contents for markdown files.

Installation

From source

To build the MDToc from scratch, make sure you have a working Go 1.22+ workspace (instructions), then:

go install github.com/essentialkaos/mdtoc@latest

Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from EK Apps Repository:

bash <(curl -fsSL https://apps.kaos.st/get) mdtoc

Usage

CI Status

Branch Status
master CI
develop CI

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0