Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Fix CLI syntax for --bullets #136

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Docs: Fix CLI syntax for --bullets #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Usage: markdown-toc [options] <input>
--append: Append a string to the end of the TOC

--bullets: Bullets to use for items in the generated TOC
(Supports multiple bullets: --bullets "*" --bullets "-" --bullets "+")
(Supports multiple bullets: --bullets="*" --bullets="-" --bullets="+")
(Default is "*".)

--maxdepth: Use headings whose depth is at most maxdepth
Expand Down Expand Up @@ -356,4 +356,4 @@ Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 19, 2017._
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 19, 2017._
4 changes: 2 additions & 2 deletions cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ if (args._.length !== 1) {
' --append: Append a string to the end of the TOC',
'',
' --bullets: Bullets to use for items in the generated TOC',
' (Supports multiple bullets: --bullets "*" --bullets "-" --bullets "+")',
' (Supports multiple bullets: --bullets="*" --bullets="-" --bullets="+")',
' (Default is "*".)',
'',
' --maxdepth: Use headings whose depth is at most maxdepth',
Expand All @@ -37,7 +37,7 @@ if (args._.length !== 1) {
'',
' --no-stripHeadingTags: Do not strip extraneous HTML tags from heading',
' text before slugifying',
'',
'',
' --indent: Provide the indentation to use - defaults to \' \'',
' (to specify a tab, use the bash-escaped $\'\\t\')'
].join('\n'));
Expand Down