search

jsdoc2md / dmd

The default output template for jsdoc2md
MIT License
39 stars 49 forks source link

Escape vertical bar character. #11

Closed alexmingoia closed 9 years ago

alexmingoia commented 9 years ago

This ensures the pipe character inside param definitions or descriptions doesn't interfere with markdown tables (which use pipes to delimit cells):

// @param {Array.<Number|String>}
75lb commented 9 years ago

merci :+1:

reinstall to pick it up $ npm i -g jsdoc-to-markdown@next

75lb commented 9 years ago

btw, if you have any documented projects i could use as examples on the jsdoc2md readme, let me know..

alexmingoia commented 9 years ago

I've been using it for many projects. I have a huge complex (events, callbacks, etc) API documentation generated with it for Mio: https://github.com/mio/mio/tree/master/docs/API.md

Using it for everything now preferably. Here's some other examples: https://github.com/alexmingoia/express-elasticsearch-logger https://github.com/alexmingoia/uconsole https://github.com/alexmingoia/asserted

75lb commented 9 years ago

great, thanks - i'll definitely link to one or more of these projects in my examples list.. i just have a few more things to implement before i release this new version - will test against these projects.. thanks for the input / feedback / testing / help :+1:

75lb commented 9 years ago

fyi, from your generated docs i can tell you've fallen a little bit behind the current @next, so do a fresh install.. you'll notice a few subtle diffs in the output.. 

$ npm i -g jsdoc-to-markdown@next