Skip to content
This repository has been archived by the owner on Nov 30, 2020. It is now read-only.

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

Open
tychenjiajun opened this issue May 17, 2019 · 3 comments
Open

Comments

@tychenjiajun
Copy link
Contributor

tychenjiajun commented May 17, 2019

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.

@matsp
Copy link
Owner

matsp commented May 17, 2019

@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.

@tychenjiajun
Copy link
Contributor Author

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

@matsp
Copy link
Owner

matsp commented May 20, 2019

@tychenjiajun Yeah thats a nice example of documenation!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants