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

Auto generate documents with typedoc #15

Open
zhaoshengjun opened this issue Oct 18, 2016 · 2 comments
Open

Auto generate documents with typedoc #15

zhaoshengjun opened this issue Oct 18, 2016 · 2 comments

Comments

@zhaoshengjun
Copy link

If possible, I will sumbit a PR to use typedoc to automatically generate documentation once we have migrated to typescript. Then maybe we can use a github page to host the documents. So people can easily see the apis provided by the lib.

Discussion is more than welcome 👏

@TheLarkInn
Copy link
Member

We may not migrate to typescript for this repo (for a variety of reasons), however if you notice #39 we are adding typings (and just finalizing the details). Is typedoc capable for supporting just typings also or no?

@aciccarello
Copy link

@TheLarkInn TypeDoc should be able to document from typings. Let me know if you would like any help with this.

FYI, as a maintainer of typedoc, I'm looking into whether tapable would be helpful for our plugin system.

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

3 participants