ramda-adjunct icon indicating copy to clipboard operation
ramda-adjunct copied to clipboard

Add possibility to execute our examples directly inside documentation

Open char0n opened this issue 6 years ago • 4 comments

Each function in documentation have example demonstrating the usage of the function. Would be great if could come up with the way how to execute these examples inline and directly inside the documentation.

Embedded runkit can be used to achieve the goal: https://runkit.com/docs/embed

char0n avatar Dec 24 '19 08:12 char0n

hey @char0n what do u have in mind?

tauantcamargo avatar Dec 10 '21 14:12 tauantcamargo

@tauantcamargo well we have couple of options here.

Introduce our own repl as Ramda.js does: https://ramdajs.com/repl/ and then create links containing the exmple code as uri param to that repl. Example can be seen for example here: https://ramdajs.com/docs/#add (click on "Open in REPL")

Another alternative could be what beta React documentation did with their examples. All the examples are now runnable directly inside the documentation.

char0n avatar Dec 12 '21 11:12 char0n

Sounds nice, let me get this one.

tauantcamargo avatar Dec 12 '21 11:12 tauantcamargo

@tauantcamargo, sure. Go wild ;]

char0n avatar Dec 12 '21 11:12 char0n