Vue-devtools: Support for <docs> tag in single file components

Created on 21 Mar 2017  路  3Comments  路  Source: vuejs/vue-devtools

Some of us use an additional <docs> tag for component's documentation in .vue files.

I wonder, would support for that be technically possible in vue-devtools? Purely in the form of displaying the content when the currently selected component has such a tag.

feature request

Most helpful comment

Thanks, I'm satisfied with the answer. I'll keep it open for a while in case somebody wants to add something.

If it doesn't hit vue-devtools because it's out of the scope for the project, I guess a small community-maintained extension may be a compromise solution.

All 3 comments

It's technically possible, but it'll bloat the view. I don't think it belongs to the devtools because you can read it directly in your component file, while the state, props, etc is dynamic and cannot

Thanks, I'm satisfied with the answer. I'll keep it open for a while in case somebody wants to add something.

If it doesn't hit vue-devtools because it's out of the scope for the project, I guess a small community-maintained extension may be a compromise solution.

Does somebody have tip for a tool what can generate some kind of styleguide from single file components and can use something like in it?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

stiltet picture stiltet  路  3Comments

bajzarpa picture bajzarpa  路  3Comments

phromo picture phromo  路  4Comments

davestewart picture davestewart  路  3Comments

ablipan picture ablipan  路  5Comments