Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 2.97 KB

TESTING.md

File metadata and controls

72 lines (53 loc) · 2.97 KB
Raw

TESTING

This document helps explain how to edit html and CSS on the web site, and how to setup jekyll to test your code changes.

This is an early draft and is more likely to contain errors or omissions. Please edit if you find any problems, and contact us if you need help.

Testing the site

To edit the html files where the site is generated, those are located in

_includes and _layouts

If you're working on the html or CSS, in some cases you'll want to test your changes.

The CSS file is at: jekyll/assets/css

We use jekyll to generate the site.

Because we use jekyll for this project you don't need to commit any changes to files that are outside of the jekyll directory (unless the site is being built/updated for production).

Basically the current workflow is something like:

  • Make changes on the jekyll branch
  • Run/build the site to test the changes with bin/run-jekyll (read step #13 below). This builds and serves the site from under _site, everything under that directory gets ignored with the .gitignore file.
  • Then commit those changes if you are happy with them, excluding anything in the root directory.

Follow these instructions to get set up with jekyll:

  1. Fork the repo

Note the jekyll requirements

To install some of what's listed on their page, you may find it easier to follow these steps:

rvm can install most of the packages mentioned.

  1. You'll need gcc and make installed on your system to build the gems.
    • Linux : those can often be installed by installing the build-essential package.
    • Windows: https://cygwin.com/index.html (Other methods? Please edit this section)
    • Mac : xcode-select --install
  2. Install rvm | https://rvm.io/rvm/install
  3. Close and re-open the terminal window (this will update your PATH so rvm can be found)
  4. Update rvm | run rvm get stable --autolibs=enable
  5. run rvm install ruby
  6. Check that Ruby has been updated by running ruby -v
  7. Update the gem manager by running gem update --system
  8. Update your gems by running gem update
  9. If you are missing bundler, please install it gem install bundler
  10. Install jekyll | gem install jekyll
  11. From inside the mhwkb.github.io jekyll directory, run bundle install
  12. To start the Jekyll server | bin/run-jekyll

Periodically you will need to run bundle install in the top level directory of the jekyll branch to update the gems (you'll receive errors when you start the jekyll server).

In your browser, go to http://localhost:4000 and you should see the mhwkb.github.io web site.