You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It's listed in the CLI usage section under the -i flag since it's only used when "inserting" the TOC into the markdown file.
Feel free to submit a PR to clarify this since other people may miss that point too. There could be a "Quick start" section before "CLI" or something like that, that just shows a simple markdown file and the command to run.
Quick start
Create a markdown file: README.md
<!-- toc --># A## aa
something in aa
## ab
something in ab
Run the markdown-toc command:
markdown-toc -i README.md
Something like that might provide some more information.
It would help if the usage instructions said up front said something like:
This information does appear much later in the README.md, but it would help to have it right up front also.
Let me know if I should submit a Pull Request for this.
The text was updated successfully, but these errors were encountered: