Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

39 lines (30 loc) · 1.11 KB

Instructions to contribute to the website

The website for the workshop is built using Jekyll and hosted on GitHub pages. The main branch is protected, contributions are welcome by pull requests.

Locally building the site

Instructions can be found on the GitHub documentation here: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/

Here is a short summary:

  • Make sure Ruby 2.1.0 or higher is installed and install bundler:
$ gem install bundler:1.17.1
  • Clone this repository and go to the docs folder:
$ git clone [email protected]:LFITaskForce/FlatironMeeting.git
$ cd FlatironMeeting/docs
  • Install Jekyll and dependencies using:
$ bundle install --path ~/.gem

(Or adapt this command if you want to install the gems somewhere else)

  • Serve the website with:
$ bundle exec jekyll serve

This should start a server and make the website accessible at a local address like http://127.0.0.1:4000/FlatironMeeting/

And that's it, only type the last step to restart the server the next time around.