docs/content/2.guide/3.url-structure.md at main

davidwindham.com / npmx.dev

forked from npmx.dev/npmx.dev

fork atom

[READ-ONLY] a fast, modern browser for the npm registry

fork atom

npmx.dev / docs / content / 2.guide / 3.url-structure.md

at main 47 lines 2.3 kB view raw view rendered

wrap content

Marcus Blättermann refactor: replace carbon icons (#1454) 7w ago

9e345ef7

 1---
 2title: URL Structure
 3description: Understand how URLs work in npmx.dev
 4navigation:
 5  icon: i-lucide:link
 6---
 7
 8npmx.dev supports npm-compatible URLs and simpler alternatives.
 9
10## Use npm-compatible URLs
11
12Replace `npmjs.com` with `npmx.dev` (or `xnpmjs.com`) in any npm URL:
13
14| npm URL                         | npmx.dev equivalent                                                    |
15| ------------------------------- | ---------------------------------------------------------------------- |
16| `npmjs.com/package/nuxt`        | [`npmx.dev/package/nuxt`](https://npmx.dev/package/nuxt)               |
17| `npmjs.com/package/@nuxt/kit`   | [`npmx.dev/package/@nuxt/kit`](https://npmx.dev/package/@nuxt/kit)     |
18| `npmjs.com/package/vue/v/3.4.0` | [`npmx.dev/package/vue/v/3.4.0`](https://npmx.dev/package/vue/v/3.4.0) |
19| `npmjs.com/search?q=vue`        | [`npmx.dev/search?q=vue`](https://npmx.dev/search?q=vue)               |
20| `npmjs.com/~sindresorhus`       | [`npmx.dev/~sindresorhus`](https://npmx.dev/~sindresorhus)             |
21| `npmjs.com/org/nuxt`            | [`npmx.dev/org/nuxt`](https://npmx.dev/org/nuxt)                       |
22
23::tip
24Install the [npmx-replace browser extension](https://github.com/tylersayshi/npmx-replace-extension) for automatic redirects.
25::
26
27## Use simpler URLs
28
29npmx.dev also supports shorter, cleaner URLs:
30
31| Pattern                | Example                                            |
32| ---------------------- | -------------------------------------------------- |
33| `/<package>`           | [`/nuxt`](https://npmx.dev/nuxt)                   |
34| `/<package>@<version>` | [`/vue@3.4.0`](https://npmx.dev/vue@3.4.0)         |
35| `/@scope/name`         | [`/@nuxt/kit`](https://npmx.dev/@nuxt/kit)         |
36| `/@org`                | [`/@nuxt`](https://npmx.dev/@nuxt)                 |
37| `/~username`           | [`/~sindresorhus`](https://npmx.dev/~sindresorhus) |
38
39## Understand URL limitations
40
41Some npm URLs are not yet supported:
42
43| URL Pattern                  | Status                           |
44| ---------------------------- | -------------------------------- |
45| `/package/<name>/access`     | Not yet supported                |
46| `/package/<name>/dependents` | Coming soon                      |
47| `/settings/*`                | Not supported (account settings) |