Add Vue Example to documentation

[wxtim]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Problem

Context

I'm trying to render user myst to html with nice CSS in a web-app (the Cylc GUI). I currently have this pipeline:

const pipe = unified()
  .use(mystParser)
  .use(transform, new State())
  .use(mystToHast)
  .use(formatHtml)
  .use(rehypeStringify)

Which is OK-ish, but the mystmd project have told me (on discord) that they don't provide suitable CSS and that their focus is on react outputs.

Request

Your README.md suggests that outputting a Vue component is possible, but doesn't give an example of doing so. As a relative JS newbie I'd really appreciate an example.

Current solutions

This is a documentation bug - I think what I want is possible, but it's not clear from docs how to achieve it.

Proposed solutions

Add a vue example to the documentation.

[wooorm]

Hey Tim!

I don’t think we need an example for each framework: there are many frameworks. And we also don’t need examples for some frameworks: then folks will want to add other frameworks too.

There are required options. They can be gotten from react, as in the examples, but they can also be gotten from every other framework.
How to do that, depends on what framework you use.
The docs links for these required options to a deeper package, and there are examples of those values there: https://github.com/syntax-tree/hast-util-to-jsx-runtime#example-vue
So if readers don’t know how to get jsx/jsxs/Fragment from their framework, the docs point to deeper info there.

[github-actions]

Hi! This was closed. Team: If this was fixed, please add phase/solved. Otherwise, please add one of the no/* labels.

[wxtim]

@wooorm - thank you - hopefully that's what I need to unstick myself....

[wooorm]

Good luck!