adenddum / jasmine.github.io

Jasmine doc site

jasmine.github.io

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. Docs for new features go in edge
9. Docs for existing release version go in that directory
10. Modify the .js, .rb, or .py file in the src directory for the version being updated.
11. Run bundle exec rake pages to rebuild the html pages for edge. If you're editing a different version you can set the JASMINE_VERSION environment variable.
12. Preview your changes (bundle exec jekyll serve --baseurl '')
13. Commit your changes (git commit -am 'Add some docs')
14. Push to the branch (git push origin my-new-docs)
15. Create new Pull Request