Skip to content

docs: code block formatting from html to vue#301

Open
icarusgk wants to merge 1 commit intoTanStack:mainfrom
icarusgk:patch-1
Open

docs: code block formatting from html to vue#301
icarusgk wants to merge 1 commit intoTanStack:mainfrom
icarusgk:patch-1

Conversation

@icarusgk
Copy link
Copy Markdown

@icarusgk icarusgk commented Mar 29, 2026

🎯 Changes

I changed the code formatting language for the code blocks in the vue examples from html to vue for correct syntax highlighting of the .vue files displayed in quick-start.md

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

Release Notes

  • Documentation
    • Improved syntax highlighting for Vue code snippets in the quick-start guide for better readability.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4960086b-62f8-499f-8e90-2baf48ab5c44

📥 Commits

Reviewing files that changed from the base of the PR and between 0019297 and f6a9121.

📒 Files selected for processing (1)
  • docs/framework/vue/quick-start.md

📝 Walkthrough

Walkthrough

Updated code-fence language identifiers in Vue component documentation snippets from html to vue for improved syntax highlighting. Three components (App.vue, Display.vue, Increment.vue) in the quick-start guide were annotated with the correct language identifier.

Changes

Cohort / File(s) Summary
Vue Documentation
docs/framework/vue/quick-start.md
Updated code-fence language markers from html to vue for three Vue component code blocks to enable proper syntax highlighting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Hop, hop! A doc update so fine,
Language tags now correctly align,
Vue components shine bright with their hue,
Syntax highlighting makes code rings true! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly describes the main change: updating code block language identifiers from 'html' to 'vue' in documentation for proper syntax highlighting.
Description check ✅ Passed The description includes all required template sections with clear details about the changes, completed checklist items, and correct release impact designation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant