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.

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

Usage instructions should mention <-- toc --> marker at the beginning #99

Closed
dbooth-boston opened this issue Oct 24, 2017 · 2 comments
Closed

Comments

@dbooth-boston
Copy link
Contributor

dbooth-boston commented Oct 24, 2017

It would help if the usage instructions said up front said something like:

  1. Add the following line to your markdown file where you want your TOC inserted:
    <-- toc -->
  2. Run markdown-toc:
    ...

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.

@doowb
Copy link
Collaborator

doowb commented Oct 24, 2017

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.

@doowb
Copy link
Collaborator

doowb commented Dec 20, 2017

This was resolved in #100

@doowb doowb closed this as completed Dec 20, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants