arceasy icon indicating copy to clipboard operation
arceasy copied to clipboard

Extract JSDocs to create a readme

Open luiguild opened this issue 7 years ago • 5 comments

Maybe it's necessary to create a webpack plugin to do it for me

luiguild avatar May 31 '17 02:05 luiguild

I find this awesome project https://github.com/rstacruz/mdextract

luiguild avatar May 31 '17 02:05 luiguild

And this one https://github.com/thlorenz/docme

luiguild avatar May 31 '17 02:05 luiguild

Hey @luiguild, I'll take a look at these projects, I hope I can help you with the docs.

italopessoa avatar Sep 02 '17 15:09 italopessoa

docme is better than mdextract, but it has a deprecated dependence (wrench.js). I found jsdoc2md, that looks cool. some real world examples

italopessoa avatar Sep 03 '17 03:09 italopessoa

we can work with jsdoc2md! is a great project 😄

luiguild avatar Oct 08 '17 13:10 luiguild