https://github.com/yankeexe/toc-md
Generate/inject "Table of Contents" for markdown files.
https://github.com/yankeexe/toc-md
cli cli-app go go-cli golang hacktoberfest toc toc-generator
Last synced: 8 days ago
JSON representation
Generate/inject "Table of Contents" for markdown files.
- Host: GitHub
- URL: https://github.com/yankeexe/toc-md
- Owner: yankeexe
- License: mit
- Created: 2020-10-11T06:28:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-03T20:02:28.000Z (over 3 years ago)
- Last Synced: 2025-03-29T13:51:14.204Z (29 days ago)
- Topics: cli, cli-app, go, go-cli, golang, hacktoberfest, toc, toc-generator
- Language: Go
- Homepage:
- Size: 5.86 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# toc-md
Generate or inject "Table of Contents" for markdown file.
## Contents
- [toc-md](#toc-md)
- [Installation](#installation)
- [Install toc-md](#install-toc-md)
- [Verify installation](#verify-installation)
- [Usage](#usage)
## Installation
### Install toc-md
1. Download the zip from [releases](https://github.com/yankeexe/toc-md/releases)
2. unzip the tar file
```bash
$ tar -xzf toc
```
3. Copy the binary to `bin` directory.
```bash
$ sudo cp toc /usr/local/bin
```
### Verify installation
Run `toc` to see the help message.
```bash
$ toc
```
## Usage
Generate table of contents
```bash
$ toc gen "README.md"
```
Inject table of contents to the file.
```bash
$ toc gen "README.md" -i
```