Courses
Vue Foundations Vue Fullstack Vue Enterprise
Articles
Latest Topics
More
Newsletter Sponsorship Discord About
The video for this lesson is currently being updated, please read the transcript instead.
Component & API Documentation > Lesson 12

Documenting components

With Vue Styleguidist now installed and running, let's start documenting our components, beginning with the CartItem component.

Doc blocks

Similar to apiDoc, Vue Styleguidist is going to scan our component files and parse the doc blocks in order to populate the documentation.

The difference between the two, though, is that Vue Styleguidist doesn't strictly rely on block tags. What's just as important is the context of the doc block.

General description


Back to course page

Click to load comments...

Courses
  • Vue Foundations
  • Vue Fullstack
  • Vue Enterprise
Articles
  • Latest
  • Topics
Newsletter
  • Join
  • Sponsorship
More
  • Discord
  • Vue.js jobs
  • About

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

  • RSS
  • |
  • Atom