The video for this lesson is currently being updated, please read the transcript instead.

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

To view the complete lesson you'll need to login or join this course.


Click to load comments...