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

Extract client code into a plugin #38

Open
owickstrom opened this issue Dec 5, 2016 · 7 comments
Open

Extract client code into a plugin #38

owickstrom opened this issue Dec 5, 2016 · 7 comments

Comments

@owickstrom
Copy link

After some discussion with Phil about how we could improve documentation for PureScript libraries, we arrived at a design where we would like to have GitHub Pages-hosted documents easily embed runnable PureScript snippets, with something like script or pre tags, and a plugin that adds a "Run" button, posts the code to the Try PS API when the user clicks, and finally renders the output (below the snippet).

I have not had time to look into how this code is doing stuff right now, just throwing this out there. 😄

Thx!

@paf31
Copy link
Contributor

paf31 commented Dec 6, 2016

👍 I think the simplest thing we can do here is to just extract the code which calls the service and runs the generated JS in an iframe, into its own JS library which can be included in documentation/blogs etc.

@paf31 paf31 changed the title Extract try purescript client code to a plugin Extract client code into a plugin Dec 9, 2016
@soupi
Copy link
Contributor

soupi commented Dec 26, 2016

Hopefully I'll start working on this this week

@soupi
Copy link
Contributor

soupi commented Jan 3, 2017

Some stuff came up. May take a bit longer until I can work on this. Sorry.

@paf31
Copy link
Contributor

paf31 commented Jan 3, 2017

No rush at all, thanks!

@sudhirvkumar
Copy link
Contributor

@paf31 @soupi this will be an awesome feature.

We can embed in documentation / help. Most importantly we can create something like a Notebook where people can type code and execute. Would be super useful for building Interactive training material ;)

@soupi
Copy link
Contributor

soupi commented Aug 12, 2017

I'm sorry I haven't implemented this yet. If anyone wants to pick this up they are welcomed to. It might take a bit of time until I can work on this.

@sudhirvkumar
Copy link
Contributor

let me try this next weekend

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

No branches or pull requests

4 participants