Source for Jasmine's documentation
git checkout -b my-new-docs)
gem install bundler) are installed
bundle install --path vendor/bundle)
You're ready to make some changes to the documentation!
Note the auto-generated files
_tutorials/*.html, don't edit these files as any changes you make to them will be lost the next time the documentation is generated.
First, update the jasmine API docs:
bundle exec rake update_edge_jasmineand
bundle exec rake update_edge_jasmine_browser
npm run jsdocto update the API documentation
Then, regenerate the tutorials:
bundle exec rake tutorials
Now preview your changes locally:
bundle exec rake serve
To archive the API docs for an older version of jasmine-core, add
archived: trueto the YAML at the top of
_api//global.html. 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.
git commit -am 'Add some docs')
git push origin my-new-docs)
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
jasmine.github.io, create the branch
git checkout master
git checkout -b gh-pages
git push -u origin HEAD
Next, enable GitHub Pages for your fork:
GitHub Pagesheader, select
Now that you've configured your live demo link to show the
gh-pagesbranch, 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
my-complicated-change, 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
my-complicated-changebranch. You can then include a link to the demo in your pull request.