https://github.com/essentialkaos/mdtoc

Utility for generating table of contents for markdown files
https://github.com/essentialkaos/mdtoc

golang markdown utility

Last synced: about 1 month ago
JSON representation

Utility for generating table of contents for markdown files

• Host: GitHub
• URL: https://github.com/essentialkaos/mdtoc
• Owner: essentialkaos
• License: apache-2.0
• Created: 2016-05-01T23:31:40.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-21T11:42:49.000Z (3 months ago)
• Last Synced: 2024-10-21T16:42:49.736Z (3 months ago)
• Topics: golang, markdown, utility
• Language: Go
• Homepage: https://kaos.sh/mdtoc
• Size: 268 KB
• Stars: 5
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        




  

  

  

  



Installation • Usage • CI Status • Contributing • License





`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+](https://github.com/essentialkaos/.github/blob/master/GO-VERSION-SUPPORT.md) workspace ([instructions](https://go.dev/doc/install)), then:

```

go install github.com/essentialkaos/mdtoc@latest

```

#### Prebuilt binaries

You can download prebuilt binaries for Linux and macOS from [EK Apps Repository](https://apps.kaos.st/mdtoc/latest):

```

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

```

### Usage



### CI Status

| Branch | Status |

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

| `master` | [![CI](https://kaos.sh/w/mdtoc/ci.svg?branch=master)](https://kaos.sh/w/mdtoc/ci?query=branch:master) |

| `develop` | [![CI](https://kaos.sh/w/mdtoc/ci.svg?branch=develop)](https://kaos.sh/w/mdtoc/ci?query=branch:develop) |

### Contributing

Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/contributing-guidelines#contributing-guidelines).

### License

[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)