feat(@vben/docs): preview components are supported within documents

[anncwb]

Description

close #4222

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

• If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
• Run the tests with pnpm test.
• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features

  • Introduced a DemoPreview component for displaying file previews with error handling.
  • Added a PreviewGroup component for a tabbed interface to view code snippets or files.
  • Enhanced documentation for modal components and integration of new UI elements.

• Bug Fixes

  • Improved error handling for file parsing in the preview component.

• Documentation

  • Updated and expanded documentation for various components, including modals and their usage.

• Chores

  • Updated dependencies and development tools for improved functionality and maintainability.

• Style

  • Enhanced styles for tooltips and modal components for better user experience.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 4ce032d

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

[coderabbitai]

Warning

Rate limit exceeded

@anncwb has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 11 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between d47d051 and 4ce032d.

Walkthrough

The recent changes introduce several new components and enhancements to the Vben Admin documentation, focusing on supporting component previews. New Vue components, such as DemoPreview and PreviewGroup, have been added to facilitate the display of files and code snippets. Additionally, various configuration files have been modified to improve the overall structure and usability of the documentation, along with updates to dependencies and styling.

Changes

Files	Change Summary
docs/.vitepress/components/demo-preview.vue	Introduced a structured preview interface for displaying files with error handling and dynamic rendering.
docs/.vitepress/components/index.ts	Exported the newly created DemoPreview component for modular use.
docs/.vitepress/components/preview-group.vue	Implemented a tabbed interface for displaying code snippets, enhancing user interaction.
docs/.vitepress/config/en.mts	Updated navigation label from "Technical Support" to "Tech Support."
docs/.vitepress/config/index.mts	Corrected import from shard to shared for proper configuration loading.
docs/.vitepress/config/plugins/demo-preview.ts	Created a VitePress plugin to integrate demo components into Markdown documentation.
docs/.vitepress/config/shared.mts	Enhanced configuration with dark theme preference and improved markdown processing.
docs/src/components/common-ui/vben-modal.md	Added comprehensive documentation for the modal component, including usage and API reference.
docs/package.json	Updated dependencies to include new UI component libraries and enhance TypeScript support.

Assessment against linked issues

Objective	Addressed	Explanation
Support component preview in the document (#4222)	✅

🐰 In the meadow where bunnies play,
New previews hop in, brightening the day!
With tabs and modals, oh what a sight,
Documentation’s now a pure delight!
So let’s cheer for the code, and all it can do,
For every little change, we say thank you! 🌼✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.