Skip to content

dqweek/jasmine.github.io

 
 

Repository files navigation

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

About

Source for Jasmine's documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 65.9%
  • JavaScript 31.5%
  • CSS 1.6%
  • Other 1.0%