Need help with
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

515 Stars 397 Forks MIT License 507 Commits 8 Opened issues


Source for Jasmine's documentation

Services available


Need anything else?

Contributors list

Jasmine doc site


Prepare your local environment

  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 (
    1. You can install them in the local folder, instead of globally for the system with (
      bundle install --path vendor/bundle
  5. Install JS dependencies (
    npm install

Make your changes

You're ready to make some changes to the documentation!

├── _api/                   # Auto-generated API documentation - don't edit by hand!
├── _faq/                   # Various FAQ pages
├── _includes/              # Jekyll snippets (headers, footers, etc.)
├── _layouts/               # Jekyll layouts (overall page structure)
├── _tutorials/             # Tutorials / How-to Articles
│   ├── src/                # Docco source files for "side-by-side" tutorials
│   ├── *.html              # Auto-generated docco tutorials - don't by edit by hand!
│   ├── *.md                # Newer markdown tutorials
├── css/                    # Stylesheets (SCSS)
├── examples/               # Raw javascript examples of jasmine tests (rare)
├── pages/                  # Various documentation pages

Note the auto-generated files

, don't edit these files as any changes you make to them will be lost the next time the documentation is generated.

Test your changes

First, update the jasmine API docs:

  • Update local copies of jasmine using
    bundle exec rake update_edge_jasmine
    bundle exec rake update_edge_jasmine_browser
  • Run
    npm run jsdoc
    to update the API documentation

Then, regenerate the tutorials:

  • bundle exec rake tutorials

Now preview your changes locally:

  • bundle exec rake serve

Archiving a version of the jasmine-core API docs

To archive the API docs for an older version of jasmine-core, add

archived: true
to the YAML at the top of
. This will remove the version from the listing on the docs home page. It will still be published at the same URLs and can still be reached through the All versions link.

Submit your changes

  • Commit your changes (
    git commit -am 'Add some docs'
  • Push to the branch (
    git push origin my-new-docs
  • Create new Pull Request

Advanced: providing a live demo

If you're making complicated or potentially controversial changes to the documentation, it may make sense to provide a live demo that the reviewer can use to compare side-by-side with the current production site.


From the terminal in your local fork of
, create the branch
  • git checkout master
  • git checkout -b gh-pages
  • git push -u origin HEAD

Next, enable GitHub Pages for your fork:

  • Open your browser and navigate to your fork in GitHub
  • Click the
  • Under the
    GitHub Pages
    header, select
    gh-pages branch
  • The page will reload. Wait a few minutes, then click the link provided
  • You now have a personal live demo under

Demoing your desired branch

Now that you've configured your live demo link to show the

branch, you can update what is shown at any time by resetting that branch to your newest changes. For example, if you've just pushed up the branch
, update your live demo by entering the following in your terminal:
  • git checkout gh-pages
  • git reset --hard my-complicated-change
  • git push -f

Wait a few minutes, and you live demo will now be showing your changes in the

branch. You can then include a link to the demo in your pull request.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.