H
H
hckn2019-01-02 15:25:33
Vue.js
hckn, 2019-01-02 15:25:33

How do you document components?

What are some convenient ways to document components?
1. Comments in the component file itself are not very convenient
2. Creating a markdown file next to the component - then there are 2 times more files = dump
3. A separate bible for demos looks like overkill if we are talking about a working template, and not some kind of demo versions.
How to embed documentation directly into a working template?

Answer the question

In order to leave comments, you need to log in

1 answer(s)
N
NaN, 2019-01-09
@KornevaViktoria

We make a folder for each component with an .md file containing a description and examples

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question