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 assume that markdown-toc is in the PATH, but it isn't #98

Open
dbooth-boston opened this issue Oct 24, 2017 · 3 comments
Labels

Comments

@dbooth-boston
Copy link
Contributor

dbooth-boston commented Oct 24, 2017

The instructions say to install like this:

$ npm install --save markdown-toc

and then use it from the command line like this:

markdown-toc [options] <input>

But the installation does not put markdown-toc in the user's path, so the result of the above is "command not found". It would be helpful if the usage instructions said something like this:

./node_modules/.bin/markdown-toc [options] <input>

Very nice tool though! Thanks for providing it! And let me know if I should submit a Pull Request for this.

@doowb
Copy link
Collaborator

doowb commented Oct 24, 2017

Thanks, we'll get the readme updated.

If you install it globally, then you can use markdown-toc from any directory:

npm install --global markdown-toc

@doowb doowb added the docs label Oct 24, 2017
@dbooth-boston
Copy link
Contributor Author

I suggest including the --global option in the installation instructions. That will simplify things and take care of the problem.

@slavaaaaaaaaaa
Copy link

#127 resolves this; I ran into the same problem and actually found this issue after making the PR. Wooo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants