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

Support for @tutorial #115

Open
justin-calleja opened this issue Feb 24, 2017 · 1 comment
Open

Support for @tutorial #115

justin-calleja opened this issue Feb 24, 2017 · 1 comment
Labels
enhancement more info More info required to reproduce template Requires a change to a dmd partial/helper

Comments

@justin-calleja
Copy link

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 added a commit to justin-calleja/no-dups-validator that referenced this issue Feb 26, 2017
….js' from doc conf.json

'lib/index.js' was removed from doc conf.json as '--files' must be provided (see
jsdoc2md/jsdoc-to-markdown#115)
@75lb 75lb added the template Requires a change to a dmd partial/helper label Aug 27, 2024
@75lb
Copy link
Member

75lb commented Sep 1, 2024

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

@75lb 75lb added the more info More info required to reproduce label Sep 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement more info More info required to reproduce template Requires a change to a dmd partial/helper
Development

No branches or pull requests

2 participants