Giter Club home page Giter Club logo

jasmine.github.io's Introduction

Jasmine doc site

Contributing

Note: The files in the _api directory are generated by jsdoc. Don't edit them by hand. If you do, your changes will be overwritten the next time somebody generates them.

  1. Fork the repo
  2. Create your feature branch (git checkout -b my-new-docs)
  3. Ensure ruby and bundler (gem install bundler) are installed
  4. Install ruby dependencies (bundle)
  5. You can install them in the local folder, instead of globally for the system with (bundle install --path vendor/bundle)
  6. Install pygments (pip install pygments) - would need python and pip (http://pygments.org/)
  7. Make your modifications
  8. API docs are generated from the jasmine-core source files, update them with bundle exec rake update_edge_jasmine
  9. Run npm run jsdoc to regenerate jsdoc pages from .js files.
  10. Tutorials are in the _tutorials directory
  11. Basic markdown files go directly in _tutorials
  12. Docco style (side-by-side) documents should live in _tutorials/src
  13. Docco tutorials are generated with bundle exec rake tutorials
  14. Preview your changes (bundle exec jekyll serve --baseurl '')
  15. Commit your changes (git commit -am 'Add some docs')
  16. Push to the branch (git push origin my-new-docs)
  17. Create new Pull Request

jasmine.github.io's People

Contributors

briandipalma avatar cancerberosgx avatar cbpetersen avatar daniel-hug avatar dsernst avatar dvberkel avatar elgalu avatar gentooboontoo avatar gerg avatar igorshubovych avatar jaapz avatar janv avatar jaril avatar jbrudvik avatar jdhines avatar jfairbank avatar kevgathuku avatar lagartoflojo avatar liuxh0 avatar ljwall avatar mamachanko avatar nfriedly avatar pixnbits avatar ryanwilsonperkin avatar scottillogical avatar sgravrock avatar sheelc avatar staeff avatar stratigos avatar tjgrathwell avatar

Watchers

 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.