Skip to content

Commit 86b4771

Browse files
committed
Renamed tool to markdown-github-toc
1 parent ff0fe90 commit 86b4771

File tree

4 files changed

+14
-13
lines changed

4 files changed

+14
-13
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# markdown-utilities
2+
23
A collection of small handy tools for improving and converting markdown.
34

45
## Install
@@ -11,11 +12,11 @@ A collection of small handy tools for improving and converting markdown.
1112

1213
<!-- toc -->
1314

14-
- [markdown-utilities-github-toc](#markdown-utilities-github-toc)
15+
- [markdown-github-toc](#markdown-github-toc)
1516

1617
<!-- tocstop -->
1718

18-
# markdown-utilities-github-toc
19+
# markdown-github-toc
1920

2021
Add Github compatible table of content to markdown (Replacing "&lt;!-- toc --&gt;" in source file)
2122

@@ -25,17 +26,17 @@ This tools uses [markdown-toc](https://github.com/jonschlinkert/markdown-toc#toc
2526

2627
```
2728
Usage:
28-
$ markdown-utilities-github-toc <source> [<destination>] [<options>]
29+
$ markdown-github-toc <source> [<destination>] [<options>]
2930
3031
<source> must be a markdown file, with the extension '.md'.
3132
<destination> must be a markdown file, with the extension '.md'
3233
if ommitted it will be named <source>-toc.md
3334
3435
3536
Examples:
36-
$ markdown-utilities-github-toc README.md
37-
$ markdown-utilities-github-toc in.md out.md --maxdepth 3
38-
$ markdown-utilities-github-toc README.md --insert
37+
$ markdown-github-toc README.md
38+
$ markdown-github-toc in.md out.md --maxdepth 3
39+
$ markdown-github-toc README.md --insert
3940
4041
Options:
4142
--help Display this menu

bin/markdown-github-toc.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ const meow = require('meow')
1212
const cli = meow(
1313
`
1414
Usage:
15-
$ markdown-utilities-github-toc <source> [<destination>] [<options>]
15+
$ markdown-github-toc <source> [<destination>] [<options>]
1616
1717
<source> must be a markdown file, with the extension '.md'.
1818
<destination> must be a markdown file, with the extension '.md'
1919
if ommitted it will be named <source>-toc.md
2020
2121
2222
Examples:
23-
$ markdown-utilities-github-toc README.md
24-
$ markdown-utilities-github-toc in.md out.md --maxdepth 3
25-
$ markdown-utilities-github-toc README.md --insert
23+
$ markdown-github-toc README.md
24+
$ markdown-github-toc in.md out.md --maxdepth 3
25+
$ markdown-github-toc README.md --insert
2626
2727
Options:
2828
--help Display this menu

docs/build.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22

33
cd "$(dirname "$0")/.."
44

5-
markdown-tools-github-toc README.md --insert --maxdepth 1
6-
markdown-tools-github-toc docs/toc-test.md --insert
5+
markdown-github-toc README.md --insert --maxdepth 1
6+
markdown-github-toc docs/toc-test.md --insert

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@
2626
"prettier": "1.18.2"
2727
},
2828
"bin": {
29-
"markdown-utilities-github-toc": "bin/markdown-github-toc.js"
29+
"markdown-github-toc": "bin/markdown-github-toc.js"
3030
}
3131
}

0 commit comments

Comments
 (0)