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

Support for @tutorial

Open justin-calleja opened this issue 8 years ago • 1 comments

I have tried using JSDoc 3's @tutorial with jsdoc-to-markdown with no success.

I'm trying to extract common documentation in an npm package and include parts in other packages. I'm using @tutorial for explanation of things which are not bound to symbols e.g. functions or typedefs. For e.g. I'd like to explain what currying is once in this package, and include that documentation in other packages all of which use currying.

It would be great if jsdoc-to-markdown supports @tutorial out of the box. Second best would be a plugin for it (I'm trying to get my head around writing a partial for it. I'm not sure how to access tutorials and list them out. Also, I don't know how to link to a tutorial in functions in which I add @tutorial curry for e.g.)

justin-calleja avatar Feb 24 '17 11:02 justin-calleja