Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 2.3 KB

README.md

File metadata and controls

62 lines (43 loc) · 2.3 KB

Phase 2 Template

This will be the template to use for the delivery of Phase 2 of the DensityDesign Final Design Synthesis Studios 2019/2020.

It uses Jekyll, a static website generator, so you can focus on the content and the visualizations of your research. However, you're free to customize the look and feel of the report by changing colors and fonts. You will find the editable stylesheet inside the folder _sass/variables.scss. Remember to link the fonts from Google Fonts in the <head> tag on your HTML file under _layouts/default.html.

Step-by-step installation (macOS)

  1. Video tutorial for macOS
  2. Video tutorial for Windows

Update Ruby

Open your terminal in a new window. On the window title bar it should say your username.

Install RVB (Ruby Version Manager) using the command

curl -sSL https://raw.githubusercontent.com/rvm/rvm/master/binscripts/rvm-installer | bash -s stable

Restart your terminal to have rvm running on your computer!

Update Ruby to the latest stable version

rvm install ruby-2.6.5

Install the Xcode command line on your Mac. You will not need it directly but it's required to make everything work.

xcode-select install

Install Jekyll before downloading the repository

In the same window as before, to install Jekyll globally on your computer, type

$ gem install jekyll bundler

If you get permissions error, type

$ sudo gem install jekyll bundler

and then insert your computer's password (it will not show dots or asterisks, so it will seem like you're not typing).

Run your template locally

Now that you installed Jekyll on your computer, you are ready to start working.

Download this repository as a zip on your computer, open the folder in your terminal (by dragging it onto the terminal icon in the dock, or by opening it through Github) and type

$ bundle install

to install all the packages needed to make the website work. This command must be run only the first time!

Finally, you can type

$ bundle exec jekyll serve

to see a live version of your website on a local server like http://127.0.0.1:4000/ in your browser.