Skip to content

CLI program to generate TOC(table of content) for markdown notes directory

License

Notifications You must be signed in to change notification settings

dreamjz/gomdtoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gomdtoc

CLI program to generate TOC(table of content) for markdown notes directory, build with Cobra

1. Example

2. Installation

Install with go

$ go install -ldflags "-s -w" "github.com/dreamjz/gomdtoc@latest"

Binary file

Download the binary file from Release

3. Usage

$ gomdtoc directory_path [flags]
$ gomdtoc -h
CLI program to generate toc for markdown notes directory

Usage:
  gomdtoc [flags]

Flags:
  -h, --help           help for gomdtoc
  -r, --recursive      --recursive; generate TOC file for every sub-directory
  -s, --skip strings   --skip dir_name1,dir_name2, ...; skip specified directories
  -t, --title string   --title title_field, specify the title field in frontmatter  (default "title")

About

CLI program to generate TOC(table of content) for markdown notes directory

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages