Skip to content

Commit

Permalink
docs: add start and end to API
Browse files Browse the repository at this point in the history
  • Loading branch information
strdr4605 committed Apr 12, 2020
1 parent 96666c0 commit ef5f821
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,17 @@ Options:
provided [string]
--slug, -s, --header, -h Specify header slug to jump to.
Note: use text after "#" in url.
https://github.com/<user>/<repo>#api -> api
https://github.com/<user>/<repo>#api ->
api
[string]
--start Specify header from where to start adding links.
Notes:
multiple words should be wrapped in quotes "
will much by RegExp [string]
--end Specify header to where to end adding links.
Notes:
multiple words should be wrapped in quotes "
will much by RegExp [string]
--maxLevel, -l, --max-level Specify maximal header level to insert links.
Note: value between 1 and 6
[number] [choices: 1, 2, 3, 4, 5, 6] [default: 6]
Expand Down

0 comments on commit ef5f821

Please sign in to comment.