Guide
URL Structure
Understand how URLs work in npmx.dev
npmx.dev supports npm-compatible URLs and simpler alternatives.
Use npm-compatible URLs
Replace npmjs.com with npmx.dev (or xnpmjs.com) in any npm URL:
| npm URL | npmx.dev equivalent |
|---|---|
npmjs.com/package/nuxt | npmx.dev/package/nuxt |
npmjs.com/package/@nuxt/kit | npmx.dev/package/@nuxt/kit |
npmjs.com/package/vue/v/3.4.0 | npmx.dev/package/vue/v/3.4.0 |
npmjs.com/search?q=vue | npmx.dev/search?q=vue |
npmjs.com/~sindresorhus | npmx.dev/~sindresorhus |
npmjs.com/org/nuxt | npmx.dev/org/nuxt |
Install the npmx-redirect extension for automatic redirects from npmjs.com.
Use simpler URLs
npmx.dev also supports shorter, cleaner URLs:
| Pattern | Example |
|---|---|
/<package> | /nuxt |
/<package>@<version> | /vue@3.4.0 |
/@scope/name | /@nuxt/kit |
/@org | /@nuxt |
/~username | /~sindresorhus |
Share exact feature URLs
npmx.dev keeps package exploration views in routes or query parameters so you can copy and share the exact state you are looking at.
| View | Example |
|---|---|
| Search results | /search?q=vue |
| Package comparison | /compare?packages=react,preact |
| Source file or line | /package-code/vue/v/3.5.27/... |
| Generated docs | /package-docs/ufo/v/1.6.3 |
| Version diff | /diff/vue/v/3.5.26...3.5.27 |
| Changelog | /package-changelog/vue/v/3.5.27 |
| Timeline | /package-timeline/vue/v/3.5.27 |
Understand URL limitations
Some npm URLs are not yet supported:
| URL Pattern | Status |
|---|---|
/package/<name>/access | Dedicated access URL not yet supported |
/package/<name>/dependents | Coming soon |
/settings/* | Not supported (account settings) |