markdown-toc icon indicating copy to clipboard operation
markdown-toc copied to clipboard

Usage instructions assume that markdown-toc is in the PATH, but it isn't

Open dbooth-boston opened this issue 8 years ago • 3 comments

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.

dbooth-boston avatar Oct 24 '17 21:10 dbooth-boston

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 avatar Oct 24 '17 21:10 doowb

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

dbooth-boston avatar Oct 25 '17 00:10 dbooth-boston

https://github.com/jonschlinkert/markdown-toc/pull/127 resolves this; I ran into the same problem and actually found this issue after making the PR. Wooo

slavaaaaaaaaaa avatar Aug 09 '18 20:08 slavaaaaaaaaaa