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

Automated documentation generation #12

Open
bencompton opened this issue Mar 27, 2018 · 1 comment
Open

Automated documentation generation #12

bencompton opened this issue Mar 27, 2018 · 1 comment

Comments

@bencompton
Copy link
Collaborator

bencompton commented Mar 27, 2018

It would be great to have the ability to annotate universal component props, methods, etc. with JSDoc and have the compiler convert the casing automatically. The JSDoc can then become the basis for auto-generated docs for a component library.

@bencompton bencompton assigned bencompton and unassigned bencompton Mar 27, 2018
@bencompton bencompton changed the title Separate out runtime dependencies Automated documentation generation (JSDoc compilation) Mar 28, 2018
@nolimits4web
Copy link
Member

didn't work with it, but sounds good, need give a try. I was also thinking about using https://docusaurus.io which is Facebook's platform too. And looks like React's website is done with this. Need to also check it

@bencompton bencompton changed the title Automated documentation generation (JSDoc compilation) Automated documentation generation Mar 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants