-
Notifications
You must be signed in to change notification settings - Fork 122
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
feature/typedoc: ready for auto generate typescript documentation #71
Conversation
@RSginer — Thank you for you PR, much appreciated! I really like the feature, but as mentioned in #70, we must think about how many people will use this feature vs the fact that it adds a lot of new dependencies, which makes If others are interested in having the feature, I am definitely open to adding it. So I would suggest that others add a comment to this PR if they wish to have this included, so that we can merge this PR if there is enough interest. Meanwhile, we could put up a wiki page with guidelines on how to generate docs using typedoc and gulp. So if you could provide the guidelines in a written text, that would be awesome. Thanks again for your efforts! 👍 |
Maybe you want to create branch for this if is not instersting by default. Anyway i will create a guide in the wiki. Nice work! |
I think it is a main feature for a library. The most of libraries have and need docs 👍 |
I also agree. It can be a great plus for this generator if it has documentation out of the box |
I have been researching and maybe it is better to generate the documentation with compodoc ` I could implement it in the project if it is more interesting comment about it please |
@RSginer — I had a look at both and I think compodoc is a better fit. The resulting documentation is more relevant since it is aimed at Angular code. Do you want to create a PR for it or do you want me to add it? Thanks again for your help! 👍 |
FYI, the command to run compodoc would be: $ ./node_modules/.bin/compodoc src -p src/tsconfig.es5.json -s |
Thanks i want to send a PR :) Give me a day to prepare it and i can implement compodoc. Thanks again for the command |
@RSginer — Awesome, if you need help, just shout 👍 |
Closed in favor of #76 |
I think this feature is very interesting for all libraries. I added a gulp task for generate typescript docs, i am using this on my library project: https://ngbat.github.io/robin-ui/docs/