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

docs: Add auto-generated JSDoc content #7

Open
Techassi opened this issue Jan 4, 2024 · 0 comments
Open

docs: Add auto-generated JSDoc content #7

Techassi opened this issue Jan 4, 2024 · 0 comments
Assignees

Comments

@Techassi
Copy link
Member

Techassi commented Jan 4, 2024

Create a custom plugin which accepts raw Markdown content and replaces

```jsdoc
<SYNTAX>
```

with auto-generated content. The exact replacement content needs to be explored. One possibility is to inject raw Markdown content again, which Vitepress can then render into HTML.

This feature would enable us to display documentation on pieces of code in the documentation without the hassle to maintain this section of the documentation. This is part of the effort to eliminate papercuts when using the library, see #5.

This would also most likely require a migartion to https://github.com/vue-youtube/vue-youtube (already mentioned in #6).

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

1 participant