Articles
Latest
More
Newsletter Sponsorship Discord About
Sign up for our Newsletter
Component & API Documentation > Lesson 10

Module introduction

In this module, 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!


Back to course page

Click to load comments...

Articles
  • Latest
Newsletter
  • Join
  • Sponsorship
More
  • Discord
  • Vue.js jobs
  • About

Vue.js Developers © 2021. View our privacy policy .

  • RSS
  • |
  • Atom