search

jsdoc2md / jsdoc-to-markdown

Generate markdown documentation from jsdoc-annotated javascript
MIT License
1.68k stars 152 forks source link

Support for @tutorial #115

Open justin-calleja opened 7 years ago

justin-calleja commented 7 years ago

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.)

75lb commented 3 weeks ago

Could you post some example output please, showing me where you expect the tutorial content to appear in the jsdoc2md output.. I am ready to implement this but am looking for some feedback on how and where to display the tutorials..