material-components-vue icon indicating copy to clipboard operation
material-components-vue copied to clipboard

[Suggestion] Use embedded codepen to show example codes in vuepress

Open tychenjiajun opened this issue 5 years ago • 3 comments

Is your feature request related to a problem? Please describe. The vuepress doc now only shows examples but no codes. Users can only get example code from the vuepress source code. Although some example codes are shown in markdown in the component folder, I find it hard to write because I have to maually formatting code every time I try to update them.

Describe the solution you'd like Implement a customized component <m-codepen> in vuepress with an embedded codepen in it. Place <m-codepen> in the docs to show the example codes and provide a playground for users.

Additional context Vuedoc may also be helpful in writing docs.

tychenjiajun avatar May 17 '19 01:05 tychenjiajun

@tychenjiajun

You are right. Example code and rendered output side by side would be great. Let's collect ideas in this issue to evaluate what solutions are possible - maybe also by looking at other projects.

matsp avatar May 17 '19 05:05 matsp

@matsp Personally, I'm in favour of how Buefy documents their components.

tychenjiajun avatar May 20 '19 07:05 tychenjiajun

@tychenjiajun Yeah thats a nice example of documenation!

matsp avatar May 20 '19 12:05 matsp