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

Split "Getting Started" into sections for use in webcomponents and regular SPAs #198

Open
devtobi opened this issue Aug 22, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@devtobi
Copy link
Member

devtobi commented Aug 22, 2024

Is your feature request related to a problem? Please describe.
Main purpose of muc-patternlab-vue will be the use while developing web components.
However I think its good to provide documentation for both the SPA and the web component case.

Describe the solution you'd like
I suggest to split the page into a "General" section that always applies, as well as "SPA" and "Web Component" specific parts. (Maybe by using subsections or completely separate pages, depends on amount of content)

For the "Web Component" section I suggest adding a note, that vite-plugin-css-injected-by-js is required to make muc-patternlab-vue work in those scenarios.

Describe alternatives you've considered

Additional context

@devtobi devtobi added the documentation Improvements or additions to documentation label Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant