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