vue-styleguidist VS vue-3-storybook-demo

Yeah there’s a recent issue with the main docblock not being detected when using

Unfortunately, I found no way to add JSDoc comments to the counter-update event. I think it is currently not supported in vue-docgen-api, which Storybook uses under the hood to extract code comments into descriptions. Leave a comment if you know a way how to document events in Vue 3.

At my workplace we set up a small component library for stuff that we regularly (re-)use. It has gained quite some traction within our workplace so now we would like to write a proper and easy to use documentation. We would love to use something like vue-styleguidist which relies on jsDoc to generate a website to showcase and develop components.

I found some promising things like Vue Styleguidist (https://vue-styleguidist.github.io/), but unfortunately it only supports Vue 2 by now. My question is: Do you have experience in documenting your Vue 3 SFC? What tools or toolchain do you use?

Most of the frontend stack at Ecosia is built around with Vue. We also had a design style-guide built using Vue Styleguidist. Our style-guide is essentially a list of all the Vue components used across our frontend applications.

Few days ago I worked on a vue-styleguidist project and I had to use a Google Font.

I’m harping on the tests so hard because storybook can integrate with your tests like this https://mokkapps.de/blog/document-and-test-vue-3-components-with-storybook/ and then the only way storybook could fall behind is if your tests also fall behind.

I created a Counter.vue demo component to demonstrate the Storybook integration for this article. The source code is available at GitHub.