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.

Sign up for GitHub

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

Jump to bottom

Extract JSDocs to create a readme #5

Open
luiguild opened this issue May 31, 2017 · 5 comments
Open

Extract JSDocs to create a readme #5

luiguild opened this issue May 31, 2017 · 5 comments
Assignees
@luiguild
Labels
enhancement question

Comments

@luiguild
Copy link
Owner

Maybe it's necessary to create a webpack plugin to do it for me
@luiguild luiguild self-assigned this May 31, 2017
@luiguild
Copy link
Owner Author

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

@luiguild
Copy link
Owner Author

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

@italopessoa
Copy link
Contributor

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

@italopessoa
Copy link
Contributor

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

@italopessoa italopessoa mentioned this issue Sep 11, 2017
Merged
@luiguild
Copy link
Owner Author

luiguild commented Oct 8, 2017

we can work with jsdoc2md! is a great project 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@luiguild luiguild

Labels
enhancement question
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@italopessoa @luiguild