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.

Sign up for GitHub

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

Jump to bottom

Integrate with 3rd party documentation tools (Vitepress, Notebooks, etc) #1714

Open

NullVoxPopuli opened this issue Mar 21, 2024 · 0 comments

Owner

NullVoxPopuli commented Mar 21, 2024 •

edited

Loading

Prereqs:

Allow importing from arbitrary npm packages for better demos #32
[repl, the library] Add support for rendering *any* codefence #1632
- Will need to support probably more markdown environments?
- Will need to move compiler to a service worker

Goals:

for any documentation tool,
- provide a plugin for their system to emit the runtime code
- allow rendering of any language/tool inline

Stretch Goals:

provide fallback compiler in case service worker is undesired for whatever reason
- these REPLs would not be allowed to import from NPM

VitePress:

Customizable live demos (renderers?) via codefences with "meta" tags vuejs/vitepress#3676
- Customizable live demos (renderers?) via codefences with "meta" tags vuejs/vitepress#3676 (comment)
uses markdown-it instead of rehype/remark
I'd need to add a Vue Component that calls in to ember-repl
- (not bad, tbh, since ember-repl is mostly ember-agnostic, just needs some already planned re-arranging)

Markdoc:

https://markdoc.dev/docs/getting-started

NullVoxPopuli pinned this issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment