gotoc

README

gotoc

📄 Markdown table of contents generator

gotoc is a tool made in Go to generate markdown table of contents inside local git repo.
Links generated refers to Github anchors.

Install

go install github.com/axelbellec/gotoc

Usage

gotoc -file=README.md

<!-- Table of Contents generated by [gotoc](https://github.com/axelbellec/gotoc) -->
**Table of Contents** (by [`gotoc`](https://github.com/axelbellec/gotoc))
- [gotoc](#gotoc)
  - [Install](#install)
  - [Usage](#usage)
  - [Custom TOC title](#custom-toc-title)
  - [Max heading level for TOC entries](#max-heading-level-for-toc-entries)
  - [Compute TOC recursively for each `.md` file in directory/sub directories](#compute-toc-recursively-for-each-md-file-in-directory-sub-directories)
  - [Features](#features)
    - [Done](#done)
    - [Still in development](#still-in-development)

Custom TOC title

To specify custom TOC title like **Repo : Table of Contents** you can pass the argument : -title='<yourtitle>'.
To remove title from TOC, just use the option -notitle.

Max heading level for TOC entries

To limit TOC entries to a specified level of headings, use : -depth=3.

Compute TOC recursively for each .md file in directory/subdirectories

To add a TOC to all markdown files in the current directory and subdirectories just use the option -dir.

Directory architecture example :

dir1
├──── dir2
│       ├─── example.md
│       ├─── noheadings.md
│       └─── dir3
│              └─── example.md
└─── example.md

And we get :

Features

Done

• Generate TOC a top of file
• Enable custom TOC title editing
• Limit TOC entries
• Adding TOC to all files in a directory/sub directories

Still in development

• Update an existing TOC in Markdown file
• Handle multiple files input