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.

Sign up for GitHub

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

Jump to bottom

Replace vue-styleguidist with other API generator #528

Open
nichtich opened this issue Dec 2, 2019 · 2 comments
Open

Replace vue-styleguidist with other API generator #528

nichtich opened this issue Dec 2, 2019 · 2 comments
Labels
cleanup code cleanup, refactoring, testing... documentation Provide sufficient documentation
Milestone
1.12.0

Comments

@nichtich
Copy link
Member

nichtich commented Dec 2, 2019

API documentation via vue-styleguidist is slow. Maybe Vuese is better? Documentation of other parts could be done by other means (e.g. jsdoc) when these are moved into modules anyway (#522).
@nichtich nichtich added documentation Provide sufficient documentation cleanup code cleanup, refactoring, testing... labels Dec 2, 2019
@nichtich nichtich added this to the 1.8.0 milestone Dec 2, 2019
@nichtich
Copy link
Member Author

I'm experimenting with docsify (not an API generator but for manually written documentation): https://docsify.js.org/#/vue

@stefandesu
Copy link
Member

I'm all for getting rid of vue-styleguidist. We're getting regular security notifications because some dependency of it always has issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
cleanup code cleanup, refactoring, testing... documentation Provide sufficient documentation
Projects
None yet
Milestone
1.12.0
Development

No branches or pull requests
2 participants
@nichtich @stefandesu