Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add possibility to execute our examples directly inside documentation #1226

Open
char0n opened this issue Dec 24, 2019 · 4 comments
Open

Add possibility to execute our examples directly inside documentation #1226

char0n opened this issue Dec 24, 2019 · 4 comments

Comments

@char0n
Copy link
Owner

char0n commented Dec 24, 2019

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

@tauantcamargo
Copy link
Contributor

hey @char0n what do u have in mind?

@char0n
Copy link
Owner Author

char0n commented Dec 12, 2021

@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.

@tauantcamargo
Copy link
Contributor

Sounds nice, let me get this one.

@char0n
Copy link
Owner Author

char0n commented Dec 12, 2021

@tauantcamargo, sure. Go wild ;]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants