Comments (5)
Hmm. That's a good question. Let's see what we can find...
from beautiful-docs.
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.
@kentmw Does this help at all?
from beautiful-docs.
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.
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)
- Add github git tutorial
- Add Grav Docs HOT 2
- The apache webserver docs belong here! HOT 1
- Add c++ samples
- Circles and Sines
- Are you still accepting PR's? HOT 2
- Add http-api-design HOT 1
- Add Apiary Blueprint
- Do you want to go on the awesome list? HOT 2
- Update or Remove Markdoc
- Broken link to "Writing Great Documentation" HOT 6
- become part of `awesome` HOT 1
- Dead since early 2017 - no PR merges, issues responded to. Add: docz, docusaurus HOT 6
- Reorganize
- Suggesting Daux.io for gemerators HOT 1
- Add Hologram to "Generating Docs" HOT 1
- add faq template HOT 1
- Qt is moving, latest docs
- Add SassDoc HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from beautiful-docs.