Skip to content

docs: add docs for style query for badges #1571

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.

Sign up for GitHub

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

Merged
danielroe merged 4 commits into from
Feb 23, 2026
Merged

docs: add docs for style query for badges #1571

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ebf7de5
docs: format tip
btea Feb 22, 2026
5ce617a
docs: update
btea Feb 22, 2026
e46a819
docs: apply review
btea Feb 22, 2026
286ea95
docs: update
btea Feb 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/content/2.guide/1.features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,6 @@ You can add custom npmx badges to your markdown files using the following syntax

::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

Expand Down Expand Up @@ -195,3 +194,10 @@ When set to `true`, this parameter replaces the static category label (like "ver
| ------------- | -------------------- | ---------------- |
| **Version** | `version \| 3.12.0` | `nuxt \| 3.12.0` |
| **Downloads** | `downloads/mo \| 2M` | `lodash \| 2M` |

##### `style`

By passing style=shieldsio we change the appearance of the generated shields from the default one to custom one.

- **Default**: `default`
- **Usage**: `?style=shieldsio`
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Loading