TOC generator for Markdown.
- Golang based.
- No WebAPI use.
- Multiple output ways.
- Output to the stdout
- Direct Update(Inserting TOC to the next of
<!-- toc -->line directly).
- Support sections written in Japanese.
$ intoc -input (Target-Markdown-File)
Create an alias if needed.
$ intoc -input readme.md -edit
$ type readme.md
# intoc
TOC generator for Markdown.
<!-- toc -->
- [intoc](#intoc)
- [Feature](#feature)
- [How to use](#how-to-use)
- [Usage](#usage)
- [Samples](#samples)
- [Basic](#basic)
- [Depth control](#depth-control)
- [Use not hyphen but asterisk](#use-not-hyphen-but-asterisk)
- [Direct update](#direct-update)
- [Plain enumeration](#plain-enumeration)
- [No link format but keep list grammer](#no-link-format-but-keep-list-grammer)
- [How to develop](#how-to-develop)
- [Requirement](#requirement)
- [How to run](#how-to-run)
- [How to test](#how-to-test)
- [How to build](#how-to-build)
- [License](#license)
- [Author](#author)
## Feature
...
If you want to change edit-string from default <!-- toc --> to an another, use -edit-target option.
-use-plain-enum.
$ intoc -input readme.md -use-plain-enum
intoc
Feature
How to use
Usage
Samples
Basic
Depth control
Use not hyphen but asterisk
Direct update
Plain enumeration
No link format but keep list grammer
How to develop
Requirement
How to run
How to test
How to build
License
Author
-no-linkformat.
$ intoc -input readme.md -no-linkformat
- intoc
- Feature
- How to use
- Usage
- Samples
- Basic
- Depth control
- Use not hyphen but asterisk
- Direct update
- Plain enumeration
- No link format but keep list grammer
- How to develop
- Requirement
- How to run
- How to test
- How to build
- License
- Author
- Golang
- Developed and Tested on
go version go1.10.3 windows/386andgo version go1.10.3 windows/amd64
- Developed and Tested on
- github.com/stretchr/testify/assert for unittest
See run.bat, but executing go run simply.
See test.bat, but executing go test simply.
See build.bat, but executing go build simply.