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 enhancePreviewApp example to the cookbook #1639

Merged
merged 13 commits into from
Mar 6, 2024

Conversation

sandbergja
Copy link
Contributor

@sandbergja sandbergja commented Feb 20, 2024

When trying to add a vue plugin for our Vue 3 component library, I struggled with the current documentation in the cookbook. I finally found the enhancePreviewApp option which works perfectly, and is even documented in Configuration.md.

This pull request brings an example into the cookbook as well, so that anybody else who looks there for Vue 3 documentation can know it's possible and get a link to the full documentation at Configuration.md.

Copy link

changeset-bot bot commented Feb 20, 2024

⚠️ No Changeset found

Latest commit: 8da21f4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

what-the-diff bot commented Feb 20, 2024

PR Summary

  • Introduction of Vue 3 Compatibility
    A new section has been introduced to accommodate projects that employ Vue 3, thereby enhancing the overall user experience and compatibility range.

  • Inclusion of Vue 2 Compatibility
    Projects with Vue 2 are also catered for with the addition of a new Vue 2 specific section, increasing the versatility of the application.

  • Provision for Modifying Root Preview Component
    With this update, users can easily customize the root component of preview examples. This grants more flexibility to users to modify their previews as desired.

@elevatebart
Copy link
Member

Thank you much @sandbergja
This is 💯 what make me happy right now.

Copy link

cypress bot commented Mar 4, 2024

Passing run #586 ↗︎

0 57 0 0 Flakiness 0

Details:

Merge branch 'dev' into patch-1
Project: vue-styleguidist Commit: 8da21f4820
Status: Passed Duration: 15:49 💡
Started: Mar 6, 2024 3:56 PM Ended: Mar 6, 2024 4:12 PM

Review all test suite changes for PR #1639 ↗︎

@elevatebart elevatebart enabled auto-merge (squash) March 6, 2024 14:09
@elevatebart elevatebart merged commit 9eb7356 into vue-styleguidist:dev Mar 6, 2024
11 checks passed
@sandbergja sandbergja deleted the patch-1 branch March 6, 2024 16:10
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

Successfully merging this pull request may close these issues.

None yet

2 participants