Jasmine doc site
HTML JavaScript CSS Other
Switch branches/tags
Nothing to show
Clone or download
Latest commit d882b42 Aug 15, 2018
Permalink
Failed to load latest commit information.
.github Create ISSUE_TEMPLATE.md Dec 28, 2017
_api add api docs for 3.1 Aug 15, 2018
_faq Add how to help FAQ Aug 10, 2017
_includes replaced .png files with .svg Aug 2, 2018
_jsdoc_plugins Add tutorial for async work and fix links from API docs to tutorials Mar 1, 2018
_layouts Add some basic search functionality to the docs Jun 12, 2018
_tutorials Add a tutorial for creating a custom argument matcher Jun 13, 2018
_versions Remove edge from old docco docs, since they're not the preference goi… Mar 7, 2018
css fix the search box on the screen Jun 12, 2018
examples Add example suites to test custom reporters against Feb 2, 2018
images replaced .png files with .svg Aug 2, 2018
lib/jasmine-1.3.1 First attempt at introduction.js for 2.0 Oct 3, 2013
pages replaced .png files with .svg Aug 2, 2018
scripts Add some basic search functionality to the docs Jun 12, 2018
setup fix grammar May 24, 2018
src Update tests for new version paths Oct 17, 2016
.gitignore update jasmine-core to add naming for new jasmineDone data Apr 3, 2018
.ruby-version add small header back so the menu sticks too Feb 28, 2018
Gemfile Add redirects from old pages to new tutorials Feb 2, 2018
Gemfile.lock Add some basic search functionality to the docs Jun 12, 2018
LICENSE Updating copyright to Pivotal Labs Sep 2, 2013
README.md Remove travis badge from README May 16, 2018
Rakefile update jasmine-core to add naming for new jasmineDone data Apr 3, 2018
_config.yml Add redirects from old pages to new tutorials Feb 2, 2018
favicon.ico First attempt at introduction.js for 2.0 Oct 3, 2013
index.html Changed "node" to "Node.js" Jan 6, 2017
jsdoc-conf.json update jasmine-core to add naming for new jasmineDone data Apr 3, 2018
package-lock.json update jasmine-core to add naming for new jasmineDone data Apr 3, 2018
package.json update jasmine-core to add naming for new jasmineDone data Apr 3, 2018

README.md

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