fix(docs): Fixes style issues with document anchors

[chenxi-20]

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• New Features

  • Enhanced dynamic rendering of API documentation and demo components.
  • Improved user interaction handling for demo links and API names.
  • Added a new component, CmpPageVue, for better structure.

• Bug Fixes

  • Streamlined error handling and data parsing in the loadPage function.

• Refactor

  • Updated component naming conventions for consistency.
  • Simplified conditional rendering logic for demos and APIs.

• Style

  • Minor adjustments to spacing in the catalog layout.

[coderabbitai]

Walkthrough

The changes in this pull request primarily affect two Vue component files: componentsDetail.vue and components.vue. Modifications include enhancements to template structures, script logic, and style definitions. Key updates involve conditional rendering for demos and APIs, refined handling of data objects, and improved error handling in the loadPage function. The component signatures have been updated to follow Vue conventions. The overall focus is on enhancing clarity and functionality without introducing new features.

Changes

File Path	Change Summary
examples/react-site/src/views/components/...	- Updated template structure and logic in componentsDetail.vue for conditional rendering and demo handling. - Refined currJson object handling and improved error handling in loadPage. - Adjusted component signature to Demo: demo. - Minor style adjustments.
examples/sites/src/views/components/...	- Enhanced template and script logic in components.vue for dynamic rendering of API documentation and demo components. - Improved handling of API types and properties, including new reactive properties and event handling in loadPage. - Added CmpPageVue component.

Possibly related PRs

• fix(site): add <code> style in api-table #2139: This PR modifies the components.vue file, enhancing the rendering of the "desc" field, which is related to the display logic for demos and APIs, similar to the changes made in componentsDetail.vue.
• fix(anchor): [anchor] Reconstruct the anchor theme. #2225: This PR involves a significant update to the CSS variable naming convention and styles for the anchor component, which may relate to the overall styling adjustments seen in componentsDetail.vue.
• fix(link-menu): fix link-menu theme vars #2246: This PR focuses on renaming CSS variables for the link-menu component, which aligns with the theme and styling changes in componentsDetail.vue.

Suggested reviewers

• zzcr

🐇 In the code we hop and play,
With demos bright and APIs gay.
A sprinkle of style, a dash of cheer,
Our components shine, let’s give a cheer!
Code so clear, it’s a lovely sight,
Hopping along, everything feels right! 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 38b8899 and 86f299c.

📒 Files selected for processing (2)

• examples/react-site/src/views/components/componentsDetail.vue (5 hunks)
• examples/sites/src/views/components/components.vue (0 hunks)

💤 Files with no reviewable changes (1)

• examples/sites/src/views/components/components.vue

🧰 Additional context used

🔇 Additional comments (5)

examples/react-site/src/views/components/componentsDetail.vue (5)

75-75: Improved import statement for demo component

The import statement for the demo component has been updated to use PascalCase in the component registration. This change aligns with Vue's style guide for component naming conventions.

---

Line range hint 187-191: Enhanced clone operation in loadPage function

The clone operation for the demos property has been simplified and now uses optional chaining. This change improves readability and handles potential undefined values more gracefully.

---

199-201: Improved hash checking in loadPage function

The condition for checking if the hash includes a forward slash has been updated to use the includes method instead of indexOf. This change improves readability and is more idiomatic JavaScript.

---

245-245: Updated component registration

The component registration has been updated to use PascalCase for the Demo component, consistent with the import statement change. This maintains consistency throughout the file.

---

Line range hint 1-359: Overall assessment: Improved code quality and Vue best practices

The changes in this file primarily focus on enhancing code quality, improving error handling, and aligning with Vue best practices. The modifications to component naming conventions, the use of optional chaining, and the updated method for checking hash values all contribute to a more robust and maintainable codebase. These changes are approved and should positively impact the project.

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[github-actions]

[e2e-test-warn]
The component to be tested is missing.

The title of the Pull request should look like "fix(vue-renderless): [action-menu, alert] fix xxx bug".

Please make sure you've read our contributing guide