Coder Social home page Coder Social logo

jonocodes / pwder Goto Github PK

View Code? Open in Web Editor NEW
8.0 3.0 1.0 604 KB

Turn your documentation into a live demo with clickable console commands

Home Page: http://pwder.io

License: GNU General Public License v2.0

Ruby 16.16% Liquid 78.82% Shell 5.02%
docker classroom markdown pwd interactive interactive-tutorial documentation

pwder's People

Contributors

jonocodes avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

yikez978

pwder's Issues

No terminal?

When visiting :
https://pwder.io/gh/jonocodes/pwder/master/examples/nginx.md
I got an error message:

Failed to load https://labs.play-with-docker.com/: Response to preflight request doesn't pass access control check: No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'https://pwder.io' is therefore not allowed access. The response had HTTP status code 405.

https://purplepalmdash.github.io/images/2018_03_30_23_22_12_1064x315.jpg
Is it possible to use local dev environment(play-with-docker locally) rather than using https://labs.play-with-docker.com/?

I saw in screenshot.png you launched 2 terminals, are they from local dev environment?

Fix syntax highlighting on output blobs

Right now both the input and output blocks are grey. On PWD classroom this is not the case. It looks like the highlighter tag is not appearing on the output blocks.

Create 'render interactive' button

Kind of like those CI banners that show in readme's on github. Or like the 'Try in PWD' link mentioned here: docker-library/docs#912

This would effectively launch the readme in pwder.io so you dont have to know how to cut and paste it in there. Discoverability. This way someone who finds the readme can run it.

We then might want to make sure that that image does not show when rendered.

Implement pwder in javascript

It would be interesting to get this working entirely in browser instead of relying on a web service. I briefly tried to get strapdown and kramed to render GFM but it could use a little work.

Link to view source

Add 'view source' link on the bottom of pages. This would open a link to the raw readme (or the github rendered version?) in a new window.

Mechanize default theme updating

Figure out a way to keep up to date with upstream Jekyll theme better. Right the default theme file is generated by me viewing one of the rendered classroom documents. For example:
http://training.play-with-docker.com/helloworld/

I copy the HTML, then modify it to my needs. This means stripping out the header and footers, removing some scripts and DOM elements that are not needed. Then I add back some of the templating from
https://github.com/play-with-docker/play-with-docker.github.io/blob/master/_layouts/post.html

This is not efficient. There should either be a way of automating this, or at least a document that says exactly how to do this for future updates to the theme.

Additionally we should pull down copies of static assets like pwd.js and the css. Right now we are just referencing them from their original hosts, but since thats a moving target it is more brittle then having our own copy. We can host these right out of pwder by creating a route for static assets in Sinatra.

Allow heading to be hidden or title to be interrogated from content

Right now the 'title' is rendered into the title tag and as an H1 at the page top.

The user might want to specify their own H1 and then not render the title into the H1.

Also useful for migrating over old readme's that have an H1.

Another option would be to scrape the first H1 in the page and use that in the title tag. Hmmm.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.