Resources for Package Maintainers

Package Pages

Packages on npm are automatically given a special section on RunKit, like this page for stripe:

Custom Examples

By default, this package page shows a simple require statement. But, as you can see in the stripe example above, you can customize this example. To do so, just add an entry to your package.json.

"runkitExample": "var _ = require('underscore');"

You can also put the example in a separate file, if you prefer, and then add this property instead:

"runkitExampleFilename": "example.js"

If you want to read more about the npm/RunKit integration, check out this blog post.

Details & Troubleshooting

RunKit tries to make every package available as soon as its published. We do this by watching the public change feed provided by the npm registry. Typically, most packages published to the registry should be made available within a few minutes on RunKit. If there’s an unusually high amount of activity, or if your package has an installation step that takes some time, there could be an additional delay.

The service is only available for Linux at this time, so we can’t support packages that require Windows or Mac OS to run. We may also be missing binary software dependencies a package relies on. In many cases, we’re able to add these packages to get things working.

If you have a package that you believe should be available on RunKit and isn’t, please get in touch. We’re very interested in improving package fidelity on our service.

Try on RunKit button

Add a try on RunKit button to your package’s README, to let users test your package easily in their browsers.

<a href=""> <img src="" alt="Try stripe on RunKit"/> </a>