9. Module introduction

In the 11th and final module of Enterprise Vue, we'll be creating a component styleguide using Vue Styleguidist.

This styleguide will not only provide documentation for our components, but also provide live, interactive component previews.

Component documentation

We'll be documenting our components by adding doc blocks to the source code like we did for the API, including documentation of our props, events, and methods.

Usage examples

We can also provide usage examples of our components by adding a special docs tag to our single-file components.

Vue Styleguidist will mount these usage examples in the docs to provide live, interactive component previews.

Let's get started!

Discussion

0 comments