Additional Tools / Plugins #1176
Chowarmaan
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
The current compodoc provides a lot of useful developer documentation, but I do find myself generating additional documentation from other tools. This means there is another endpoint for that documentation to be displayed.
I was wondering if there is any thought to adding the ability to include other 3rd Party output, into the Compodoc documentation. I think there are two ways to do this.
I have been generating additional documentation in Swagger-UI, which I find very useful for the API documentation, especially with the annotations in the source code to extract this information. I find it very useful to keep this with my developer documentation from Compodoc, so that APIs are not broken, but can also be easily referenced when looking through the source.
NestJS (and others) have a direct plugin to Swagger UI to render an end point when the application is running, so I think something could be done similarly here. Suggestion 1, with the link, would certainly work for this as it is just a URL being rendered. Swagger can render from OpenAPI specifications, so static creation of files should work also, which would work within suggestion 2.
The other tool I find very useful is the Typescript to PlantUML (https://github.com/bafolts/tplant) sending data to Mermaid JS https://mermaid-js.github.io/mermaid/#/, to better draw class diagrams, and dependencies charts. I find this very helpful when different components in an Angular or NestJS application, have dependencies injected into them, that have dependencies, or are even extended from other classes. The visual references are very helpful and would make a good addition to Compodoc.
The Mermaid JS output could be saved as a drawing but might be best integrated into the Compodoc creation for each diagram to have some optional, additional information displayed.
Just looking to get your thoughts on this. I could try to help where possible, but I am not sure how much help I would be in coding this, except for maybe the side menu option, of suggestion 1.
Beta Was this translation helpful? Give feedback.
All reactions