Git Product home page Git Product logo

jqapi's Introduction

jQAPI - Alternative jQuery Documentation Browser

This is a revamp of https://github.com/mustardamus/jqapi and still under development.

Development Environment

The development environment consists of a Sinatra server and a Thor tool belt.

Served with Sprockets we can use CoffeeScript and SASS. Views will be written in HAML.

Requirements

You need to have Ruby and RubyGems installed.

If you don't have already, install Bundler:

gem install bundler

Then install all the other Gems:

bundle install

Generate the documentation

Download it

thor docs:download

The GitHub repo of the official docs site will be cloned/updated.

Generate it

thor docs:generate

Start it

thor dev:start

Point your browser to localhost:9292 and there you have the latest jQuery documentation with jQAPI wrapped around.

Generate static files

thor deploy:generate

Generates index.html, bundle.js, bundle.css, etc., so that the documentation can be viewed from a set of static files.

License

Released under MIT & GPL. Coded by Sebastian Senf. http://twitter.com/mustardamus

jqapi's People

Contributors

mustardamus avatar klortho avatar ilanfrumer avatar jfoley avatar

Watchers

James Cloos avatar avatar avatar

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.