Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(example-section): allow for markdown section underneath example card #27

Open
2 tasks
mesqueeb opened this issue Oct 16, 2020 · 0 comments
Open
2 tasks
Labels
enhancement New feature or request

Comments

@mesqueeb
Copy link
Member

allow for extra description underneath the example

Example of source file:
image

bottom markdown content is to be displayed underneath example card here:
https://github.com/cycraft/planetar/blob/production/packages/example-card/src/components/ExampleSection.vue#L9

Will require manual parsing of file contents, as the top "description" part is retrieved via vue-docgen.

  • use importHelpers raw loader to parse the file
  • then use regex? to retrieve the bottom JSDoc comment section
@mesqueeb mesqueeb added the enhancement New feature or request label Oct 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant