🛰 Github CDN
Github CDN is UNPKG for Github — an unofficial content delivery network for repo assets on Github.
⭐️ Features
- Fetch repo meta-data: branches, tags, and PRs
- Serve repo and Gist files
- Instant access to new changes pushed to Github *
- Great for quick prototyping / development
- Includes npm excluded files
- Node API for compatibility with Github Enterprise
* Unless the request fails due to network failure or rate-limiting
💁♀️ Endpoints
-
/:owner/:repo
- Get the default branch and all refs (branches, tags, and PRs)
- eg.
/vuejs/vue
to retrieve meta data on vuejs/vue
Example output
{ "default_branch": "master", "refs": { "heads": { ... }, "tags": { ... }, "pull": { ... } } }
-
/:owner/:repo/:ref
- Resolve repo ref if semver. Redirects to root of repo ref
- eg.
/vuejs/vue/master
- eg.
/vuejs/vue/^2.0.0
- eg.
/vuejs/vue/latest
-
/:owner/:repo/:ref?badge
- Resolves the ref and redirects to Badgen
- eg.
/vuejs/vue/latest?badge
-
/:owner/:repo/:ref/:path
- Get a file or list directory in a repo ref
- eg.
/vuejs/vue/v2.6.11/dist/
- eg.
/vuejs/vue/v2.6.11/dist/vue.min.js
-
/gist/:gist-id
- Get meta-data on a Gist: url, owner, created/updated date, and files
- eg.
/gist/feff40b0a522f0c41c4eff0b77ea1d47
-
/gist/:gist-id/:path
- Get a file from a Gist
- eg.
/gist/feff40b0a522f0c41c4eff0b77ea1d47/tulip.jpg
-
/ratelimit
- See the rate limit quota available on the Github API
- With rate limiting, Github CDN is not a production-ready solution to hosting code
🔑 Setting a custom token (for rate-limiting & private repos)
Use a Personal access token (PAT) to access your private repos and to use your rate limit quota.
This token is only stored in your browser as a cookie.
Built and maintained by @privatenumber and powered by Vercel ❤️