Hi! We're RunKit and we've put together a couple ideas on how you might use our embed feature in the node website redesign initiative. We've created some prototypes so you can play around and get a better idea of what we've been thinking about. We're super passionate about bringing documentation to life and are really excited about these possibilities!
Live Documentation - Live Demo Link
Before diving into the dedicated "Getting Started" page, we wanted to share our belief that every page has the opportunity to get a user experimenting with node. Partially inspired by Josh Ashkanas' work on Literate Programming as well as Brett Victor's famous talks, we fundamentally believe that any "dead" snippet of code is a lost opportunity. In this demo we've taken the existing markdown files that comprise the node documentation and made the substantial code samples first class citizens – meant to be interacted with directly to really see if one understands the concepts.
Getting Started - Live Demo Link
Our main goal with the "Getting Started" page we're presenting is that we try to specifically focus on what differentiates Node from other platforms, that way new users can quickly understand why they'd want to use Node instead of merely how to use Node. Additionally, we try to paint Node in the broad strokes it represents, offering explanations for its various use cases beyond just serving webpages -- all this while still maintaining interactivity.
Who Uses RunKit?
These great sites have already integrated
We're here to help! And we enjoy it! Use cases like this are why we started this project so we're super excited to contribute however we can, and assist in whatever way is needed if you decide to use RunKit. It also goes without saying that this service would be completely free.
module-fs is by far our most important technology, as Node more than any other platform is fundamentally a community effort through the amazing package ecosystem that has built up around it. I think we should be highlighting this both for its technical merits but also for its amazing accessibility.
We are dedicated to supporting every major version of Node forever. One of our main use cases is filing bugs, and we thus consider it our responsibility to maintain the reproducibility of those bugs forever. We'd love to discuss the possibility of supporting nightly Node builds in the docs as well.
The code lives on your site! We hate the idea of the fundamental components of websites being separated across privately administered databases. We want it to be easy to manage and edit your code through your existing PR flow, and even to take your code somewhere else.
RunKit is totally themable - pictured below is the custom theme Stripe uses on their home page.
RunKit is fast. We completely re-architected our embeds to support hundreds of simultaneously running examples on a page. We consider projects like the nodejs website redesign to be our primary use case and have invested heavily in it.
The RunKit team is always happy to help, I've listed the members below:
Thanks for you time!