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

Documentation using vue-component-meta #985

Closed
mlmoravek opened this issue Jun 21, 2024 · 0 comments · Fixed by #988
Closed

Documentation using vue-component-meta #985

mlmoravek opened this issue Jun 21, 2024 · 0 comments · Fixed by #988
Labels
documentation Improvements or additions to documentation

Comments

@mlmoravek
Copy link
Member

Description

Currently the components are documented using Vue Styleguidist and vue-docgen-cli.
However, they lack compatibility with modern Vue features such as script setup with generics and defineModel support.

vue-component-meta is a port of the vue language toolkit which can be used to extract information about a component. vue-component-metacan be used to parse the component props and extract documentation information.

Proposed change:

Extend the vue-docgen process by inclduing vue-component-meta information to allow the use of modern vue features without sacrificing documentation flexibility.

(This will make type-based declaration approach with the withDefaults compiler macro usable to implement proper conditional types #835)

Why Oruga need this feature

Improve documentation and use modern Vue features for documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant