[Vuejs]-Best way to document a Vue JS and Quasar application

Here are some options:

1. JSDoc with Plugins:

   • The plugin you mentioned (jsdoc-vuejs) is an option to make JSDoc work with Vue files.
   • If you encounter issues with this or any other plugin, I’d recommend first checking for updates, reading through open/closed GitHub issues, and trying out configurations others have shared.
   • Sometimes, it’s also worth revisiting the plugin’s documentation, as a slight oversight can lead to problems.

2. Vuese:

   • Vuese is a tool specifically designed to document Vue components. It parses your Vue components and generates documentation based on them.
   • It’s an excellent choice if you want a tool that is designed with Vue in mind. However, I’m not sure about its compatibility or special integrations with Quasar.

3. Vue Styleguidist:

   • Vue Styleguidist is a Vue-specific style guide generator and component explorer.
   • It’s more focused on showcasing and documenting components interactively than on purely static documentation.

4. Storybook for Vue:

   • While Storybook is not a documentation tool in the traditional sense, it provides an interactive UI to view and test your Vue components in various states.
   • You can also integrate Storybook Docs to automatically generate documentation based on your stories.

5. Custom Documentation:

   • Sometimes, the best approach, especially for larger applications or libraries, is a combination of generated documentation (from one of the tools mentioned above) and custom-written docs.
   • Tools like VuePress or Nuxt Content can help you build beautiful documentation sites that integrate well with Vue.