Skip to content

Comments

docs: format tip#1571

Open
btea wants to merge 4 commits intonpmx-dev:mainfrom
btea:docs/format-tip
Open

docs: format tip#1571
btea wants to merge 4 commits intonpmx-dev:mainfrom
btea:docs/format-tip

Conversation

@btea
Copy link
Contributor

@btea btea commented Feb 22, 2026

🔗 Linked issue

🧭 Context

GitHub doesn't seem to support the ::tip format.
supplement #1487

📚 Description

@vercel
Copy link

vercel bot commented Feb 22, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs.npmx.dev Ready Ready Preview, Comment Feb 22, 2026 1:11pm
npmx.dev Ready Ready Preview, Comment Feb 22, 2026 1:11pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
npmx-lunaria Ignored Ignored Feb 22, 2026 1:11pm

Request Review

@codecov
Copy link

codecov bot commented Feb 22, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 22, 2026

No actionable comments were generated in the recent review. 🎉


📝 Walkthrough

Walkthrough

The pull request updates docs/content/2.guide/1.features.md by adding a new badge customization parameter named style. The documentation explains that style=shieldsio produces a shields.io-compatible appearance, shows usage as ?style=shieldsio, and states the default value is default. The change is documentation-only and does not modify code or data.

🚥 Pre-merge checks | ✅ 1
✅ Passed checks (1 passed)
Check name Status Explanation
Description check ✅ Passed The pull request description is minimal and largely consists of template placeholders, but it does reference issue #1487 and the ::tip format, which relates to the documentation changes in the changeset.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/content/2.guide/1.features.md (1)

100-102: ⚠️ Potential issue | 🟠 Major

Missing :: closing tag for the ::tip block.

The ::tip component opened on line 100 is never closed. In Nuxt Content's MDC syntax, block components require an explicit :: closing marker. Without it, the parser will treat the entire remainder of the document — all headings, lists, code blocks, and the newly added style section — as content inside the tip component, causing a significant rendering regression on the live site.

The closing :: was part of the fix proposed in the previous review cycle but appears to have been dropped when applying it.

🐛 Proposed fix
 ::tip
 Make sure to replace `TYPE` with one of the options listed below and `YOUR_PACKAGE` with the actual package name (e.g., `vue`, `lodash`, or `@nuxt/kit`).
+::
 
 #### Available Badge Types

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.

2 participants