Genomic data interpretation and visualization Workshop
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Rscripts finnished liftover section Sep 6, 2017
_includes add return to top button Nov 13, 2018
_layouts add return to top button Nov 13, 2018
_posts fix timezone and module names for cleaner urls and consistency with p… Nov 13, 2018
_sass adjusted site color to match saturation and brightness of pmbio and u… Feb 7, 2018
assets add overview figure to index Nov 13, 2018
blog Module 3: GenVisR - More examples for waterfall/cnspec/cnview and mor… Jul 21, 2017
.gitignore added TSL exercise to BioMart module Sep 3, 2017
404.md Module 3: GenVisR - More examples for waterfall/cnspec/cnview and mor… Jul 21, 2017
CNAME Update CNAME Oct 23, 2018
Gemfile Restructured site base on Alembic Mar 31, 2017
Gemfile.lock adjusted site color to match saturation and brightness of pmbio and u… Feb 7, 2018
LICENSE update license info Jul 28, 2017
README.md added license section Aug 22, 2017
_config.yml fix timezone and module names for cleaner urls and consistency with p… Nov 13, 2018
acknowledgements.md additional physalia links Sep 22, 2017
alembic-jekyll-theme.gemspec Module 3: GenVisR - More examples for waterfall/cnspec/cnview and mor… Jul 21, 2017
authors.md minor consistency fixes Sep 22, 2017
course.md minor consistency fixes Sep 22, 2017
index.md add overview figure to index Nov 13, 2018
resources.md additional physalia links Sep 22, 2017
schedule.md additional physalia links Sep 22, 2017
search.md minor consistency fixes Sep 22, 2017

README.md

Overview

This is the github repo for the Genomic Visualization and Interpretations website. The website uses the static site generator jekyll and is based on the Alembic theme. Development occurs on the master branch, the live site is located on the gh-pages branch.

Installation

To install this site locally run the following commands:

  1. Clone the repo and cd into it $ git clone git@github.com:griffithlab/gen-viz-workshop.git
  2. Install the bundler $ gem install bundler
  3. Install gems $ bundle install
  4. run jekyll and watch for changes $ bundle exec jekyll serve --watch

The site should now be running on localhost port 4000. Changes to files will show up interactively on localhost:4000

Note: The _config.yml file is only read during the initial serve, changing this file will require re-running step 4 for changes to appear.

Adding Course Content

Course content is located in the _posts directory, course pages must be named following the format: year-month-day-name.md for example 0000-00-00-name.md. This naming is important for ordering course content, further the front matter tag in the markdown file should include date as well for the same reason. Additional useful tags are categories for locating a course in a specific module. An example of front matter tags in a markdown file is supplied below:

---
title: Introduction to Genomic Visualization and Interpretation
categories:
    - Day 1
feature_image: "https://unsplash.it/1200/400?image=200"
date: 0001-01-01
---

Adjusting The Navigation Header and Pages

The Navigation Header is defined in the _config.yml file. Navigation header pages are markdown files and are located in the root directory. For example the about page is located at /about.md. All markdown files should have front matter tags, see jekyll docs.

_layouts and Page Display

In General all markdown files should have a layout: front matter tag. The exception to this are files in the _posts directory which default to a post layout format. Layouts are defined in the _layouts directory which consist of html files specifying content. Jekyll uses liquid templating and this syntax is commonly seen throughout these html pages. A command such as {% include post-list.html %} will look in the _includes directory and add in the html content for post-list.html.

Hints and Tips

License

The code base for this website originates from the alembic jekyll theme by David Darnes and is licensed under an MIT license. Course content, is licensed under CC-BY-SA 4.0 unless otherwise stated.