sgilroy / jsdoc-plugin-mongoose

Plugin for JSDoc to automatically generate JSDoc documentation from Mongoose schemas for corresponding models, including data types of fields and contextual descriptions.
5 stars 1 forks source link

How to use with documentation.js #1

Open puttpotsawee opened 6 years ago

puttpotsawee commented 6 years ago

Hi,

I found your plugin pretty useful since I have my pain point writing doc for Mongoose! I was wondering would this be compatible with documentation.js?

sgilroy commented 6 years ago

@puttpotsawee I'm glad you have found it useful. I haven't used documentation.js, and when I did some searching for how to create plugins for it I only found some mentions of support for plugins, including https://github.com/documentationjs/documentation/blame/master/docs/FAQ.md#L46, but no actual details about how to create a plugin. I'd be open to exploring support for documentation.js (and potentially using it in my own projects) if I could find more details about how to do so.