Coder Social home page Coder Social logo

Comments (5)

PharkMillups avatar PharkMillups commented on June 27, 2024

Hmm. That's a good question. Let's see what we can find...

from beautiful-docs.

sdras avatar sdras commented on June 27, 2024

Depends on what kind of JS you're referring to, but I think the react docs index does a pretty nice job: https://facebook.github.io/react/index.html- the rest of their docs are more follow-along. Chartist does an amazing job showcasing with live sandbox editing: https://gionkunz.github.io/chartist-js/

I think Mark also already mentioned ember. They do a good job of this as well.

from beautiful-docs.

PharkMillups avatar PharkMillups commented on June 27, 2024

@kentmw Does this help at all?

from beautiful-docs.

kentmw avatar kentmw commented on June 27, 2024

These are great examples of sites that realize that running the actual code alongside their documentation is important. Couple things:

  • I really would love to see a library/npm package that made these things possible for other projects - having to rebuild documentation infrastructure is annoying, time consuming and error prone.
  • Bonus points would be a place where readers of the documentation could change the demo code and see how the code reacts. Change variables/constants here and there and see things change. Play with the API a bit to see if it feels right. @artemist I took a look at charlist to find the live sandbox editing you spoke of, but I couldn't find it. I saw some demo charts but no sandbox - is there a link to what you saw? EDIT: found it: https://gionkunz.github.io/chartist-js/examples.html YES! what did they use to let you do that??

from beautiful-docs.

kentmw avatar kentmw commented on June 27, 2024

I just saw: https://tonicdev.com/ as a sandbox environment that can hook into npm modules. I'm wondering if there's a way to hook premade tonic environments into documentation.

from beautiful-docs.

Related Issues (20)

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.