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

[Feature Request] Vue components in markdown #85

Open
JacobRex opened this issue Dec 10, 2020 · 1 comment
Open

[Feature Request] Vue components in markdown #85

JacobRex opened this issue Dec 10, 2020 · 1 comment

Comments

@JacobRex
Copy link

JacobRex commented Dec 10, 2020

Problem
I have markdown docs for design standards as well as vue code documentation, and I don't have a good way to disable the vue code for the design demos.

Describe the solution you'd like

  • I'd like to be able to define more than one custom markup for inline demos and pick and choose from them each time an inline demo is made (perhpas like this ```vue:no-code). Then I could do something like:
# Primary Colors
These are the primary brand colors. Use them for primary actions like saving, progressing, or upgrading.
'''vue:no-code
<template>
  <primary-colors />
</template>
<script>
import PrimaryColors from '~components/PrimaryColors';
export default {
  components: { PrimaryColors }
};
</script>
'''
  • Alternatively, perhaps theres a way to simply inline vue components right into the markdown?
# Primary Colors
These are the primary brand colors. Use them for primary actions like saving, progressing, or upgrading.
<primary-colors />

# Secondary Colors.
...

Describe alternatives you've considered
I could set a variable on certain sections of my documentation site to hide the code blocks with css, but this seems hacky and isn't ideal.

@privatenumber
Copy link
Owner

  • Use the html code block to prevent it from rendering
  • I like the idea of having some sort of annotation to disable rendering or opt into rendering
  • I also like the idea of rendering a component via tag but I'll have to think about the API

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

No branches or pull requests

2 participants