You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/2.guide/1.features.md
+29-25Lines changed: 29 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,38 +93,42 @@ Quick access to online development environments detected from package READMEs:
93
93
### Custom badges
94
94
95
95
You can add custom npmx badges to your markdown files using the following syntax:
96
-
`[](https://npmx.dev/package/YOUR_PACKAGE)`
97
96
98
-
> [!IMPORTANT]
99
-
> 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`).
97
+
```md
98
+
[](https://npmx.dev/package/YOUR_PACKAGE)
99
+
```
100
+
101
+
::tip
102
+
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`).
103
+
::
100
104
101
105
#### Available Badge Types
102
106
103
-
-**version**: Shows the latest or specific version of the package. 
104
-
-**license**: Displays the package license (e.g., MIT, Apache-2.0). 
105
-
-**size**: Shows the install size (via Bundlephobia) or unpacked size. 
-**vulnerabilities**: Shows the number of vulnerabilities found via OSV.  / 
112
-
-**dependencies**: Lists the total count of package dependencies. 
113
-
-**created**: Displays the date the package was first published. 
114
-
-**updated**: Displays the date of the most recent modification. 
115
-
-**engines**: Shows the supported Node.js version range. 
116
-
-**types**: Indicates if TypeScript types are included.  / 
117
-
-**maintainers**: Displays the total count of package maintainers. 
118
-
-**deprecated**: Shows if the package is active or deprecated.  / 
119
-
-**quality**: NPMS.io quality score based on linting and tests. 
120
-
-**popularity**: NPMS.io popularity score based on downloads and stars. 
121
-
-**maintenance**: NPMS.io maintenance score based on activity. 
122
-
-**score**: The overall NPMS.io combined score. 
123
-
-**name**: Simple badge displaying the package name. 
107
+
-**version**: Shows the latest or specific version of the package. :img{src="https://img.shields.io/badge/%233b82f6-3b82f6"class="inline align-middle h-5 w-14"}
-**downloads-month**: Alias for monthly download statistics. :img{src="https://img.shields.io/badge/%23f97316-f97316"class="inline align-middle h-5 w-14"}
-**vulnerabilities**: Shows the number of vulnerabilities found via OSV. :img{src="https://img.shields.io/badge/%2322c55e-22c55e"class="inline align-middle h-5 w-14"} / :img{src="https://img.shields.io/badge/%23ef4444-ef4444"class="inline align-middle h-5 w-14"}
116
+
-**dependencies**: Lists the total count of package dependencies. :img{src="https://img.shields.io/badge/%2306b6d4-06b6d4"class="inline align-middle h-5 w-14"}
117
+
-**created**: Displays the date the package was first published. :img{src="https://img.shields.io/badge/%2364748b-64748b"class="inline align-middle h-5 w-14"}
118
+
-**updated**: Displays the date of the most recent modification. :img{src="https://img.shields.io/badge/%2364748b-64748b"class="inline align-middle h-5 w-14"}
119
+
-**engines**: Shows the supported Node.js version range. :img{src="https://img.shields.io/badge/%23eab308-eab308"class="inline align-middle h-5 w-14"}
120
+
-**types**: Indicates if TypeScript types are included. :img{src="https://img.shields.io/badge/%233b82f6-3b82f6"class="inline align-middle h-5 w-14"} / :img{src="https://img.shields.io/badge/%2364748b-64748b"class="inline align-middle h-5 w-14"}
121
+
-**maintainers**: Displays the total count of package maintainers. :img{src="https://img.shields.io/badge/%2306b6d4-06b6d4"class="inline align-middle h-5 w-14"}
122
+
-**deprecated**: Shows if the package is active or deprecated. :img{src="https://img.shields.io/badge/%2322c55e-22c55e"class="inline align-middle h-5 w-14"} / :img{src="https://img.shields.io/badge/%23ef4444-ef4444"class="inline align-middle h-5 w-14"}
123
+
-**quality**: NPMS.io quality score based on linting and tests. :img{src="https://img.shields.io/badge/%23a855f7-a855f7"class="inline align-middle h-5 w-14"}
124
+
-**popularity**: NPMS.io popularity score based on downloads and stars. :img{src="https://img.shields.io/badge/%2306b6d4-06b6d4"class="inline align-middle h-5 w-14"}
125
+
-**maintenance**: NPMS.io maintenance score based on activity. :img{src="https://img.shields.io/badge/%23eab308-eab308"class="inline align-middle h-5 w-14"}
126
+
-**score**: The overall NPMS.io combined score. :img{src="https://img.shields.io/badge/%233b82f6-3b82f6"class="inline align-middle h-5 w-14"}
0 commit comments