2.8 KiB
unpkg is a fast, global content delivery network for everything on npm. Use it to quickly and easily load files using a simple URL like:
A few examples:
- https://unpkg.com/react@15.3.1/dist/react.min.js
- https://unpkg.com/react-dom@15.3.1/dist/react-dom.min.js
- https://unpkg.com/history@4.2.0/umd/history.min.js
You may also use a tag or version range instead of a fixed version number, or omit the version/tag entirely to use the latest tag.
If you omit the file path, unpkg will try to serve the browser bundle if present, the main module otherwise.
Append a / at the end of a URL to view a listing of all the files in a package.
Query Parameters
| Name | Default Value | Description |
|---|---|---|
| `main` | `unpkg`, `browser`, `main` | The name of the field in [package.json](https://docs.npmjs.com/files/package.json) to use as the main entry point when there is no file path in the URL |
| `meta` | `undefined` | Return metadata about a file in a package as JSON (e.g. `/any/file?meta`) |
Suggested Workflow
For npm package authors, unpkg relieves the burden of publishing your code to a CDN in addition to the npm registry. All you need to do is include your UMD build in your npm package (not your repo, that's different!).
You can do this easily using the following setup:
- Add the
umd(ordist) directory to your.gitignorefile - Add the
umddirectory to your files array inpackage.json - Use a build script to generate your UMD build in the
umddirectory when you publish
That's it! Now when you npm publish you'll have a version available on unpkg as well.