Add go dependencies for mdtoc
This commit is contained in:
parent
cb33c4ed26
commit
36959a4878
63 changed files with 12675 additions and 0 deletions
53
vendor/github.com/tallclair/mdtoc/README.md
generated
vendored
Normal file
53
vendor/github.com/tallclair/mdtoc/README.md
generated
vendored
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
# Markdown Table of Contents Generator
|
||||
|
||||
`mdtoc` is a utility for generating a table-of-contents for markdown files.
|
||||
|
||||
Only github-flavored markdown is currently supported, but I am open to accepting patches to add
|
||||
other formats.
|
||||
|
||||
# Table of Contents
|
||||
|
||||
Generated with `mdtoc --inplace README.md`
|
||||
|
||||
<!-- toc -->
|
||||
- [Usage](#usage)
|
||||
- [Installation](#installation)
|
||||
<!-- /toc -->
|
||||
|
||||
## Usage
|
||||
|
||||
Usage: `mdtoc [OPTIONS] [FILE]...`
|
||||
Generate a table of contents for a markdown file (github flavor).
|
||||
|
||||
TOC may be wrapped in a pair of tags to allow in-place updates:
|
||||
```
|
||||
<!-- toc -->
|
||||
generated TOC goes here
|
||||
<!-- /toc -->
|
||||
```
|
||||
|
||||
TOC indentation is normalized, so the shallowest header has indentation 0.
|
||||
|
||||
**Options:**
|
||||
|
||||
`--dryrun` - Whether to check for changes to TOC, rather than overwriting.
|
||||
Requires `--inplace` flag. Exit code 1 if there are changes.
|
||||
|
||||
`--inplace` - Whether to edit the file in-place, or output to STDOUT. Requires
|
||||
toc tags to be present.
|
||||
|
||||
`--skip-prefix` - Whether to ignore any headers before the opening toc
|
||||
tag. (default true)
|
||||
|
||||
For example, with `--skip-prefix=false` the TOC for this file becomes:
|
||||
|
||||
```
|
||||
- [Markdown Table of Contents Generator](#markdown-table-of-contents-generator)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Usage](#usage)
|
||||
- [Installation](#installation)
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
``` go get github.com/tallclair/mdtoc ```
|
||||
Loading…
Add table
Add a link
Reference in a new issue