robframpton / apidocs-example Goto Github PK
View Code? Open in Web Editor NEWAn dummy site for demoing API docs.
An dummy site for demoing API docs.
Search is a crucial part when perusing over API docs. Similar to what YUI had in http://yuilibrary.com/, I think we should be able to filter by Class
, Property
and Method
, for example.
Right now, methods and attributes are mixed together with no clear separation... it would be nice to have them either separated or properly marked
This I'm not 100% sure, but things like senna.js/App.js
are huge, so finding what you're looking for involves a lot of scrolling and scanning. It also makes the whole document hard to read...
Maybe we could have some kind of summary, real-live filter or jump-to-x feature to help with that?
Currently, there's no indication whatsoever that a method or attribute are private or protected. There should be some kind of clear visual indication showing that something is not meant to be accessed/used/extended...
Additionally, we could implement a series of filters to show only public facing method and attributes (or other filter options).
Related to #3
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.