Switching to GitHub-defined variables

HPC-workshops · Jul 14, 2016 · 8748a80 · 8748a80
1 parent cf51440
commit 8748a80
Show file tree

Hide file tree

Showing 12 changed files with 38 additions and 84 deletions.
diff --git a/Makefile b/Makefile
@@ -17,17 +17,16 @@ commands :
 
 ## serve            : run a local server.
 serve : lesson-rmd
-	${JEKYLL} serve --config _config.yml,_config_dev.yml
+	${JEKYLL} serve
 
 ## site             : build files but do not run a server.
 site : lesson-rmd
-	${JEKYLL} build --config _config.yml,_config_dev.yml
+	${JEKYLL} build
 
 # repo-check        : check repository settings.
 repo-check :
 	@bin/repo_check.py -s .
 
-
 ## clean            : clean up junk files.
 clean :
 	@rm -rf ${DST}

diff --git a/_config_dev.yml b/_config_dev.yml
diff --git a/_includes/all_keypoints.html b/_includes/all_keypoints.html
@@ -7,7 +7,7 @@
   {% unless episode.break %}
     <tr>
       <td class="col-md-3">
-        <a href="{{ site.root }}{{ episode.url }}">{{ episode.title }}</a>
+        <a href="{{ site.github.url }}{{ episode.url }}">{{ episode.title }}</a>
       </td>
       <td class="col-md-9">
         <ul>

diff --git a/_includes/carpentries.html b/_includes/carpentries.html
@@ -1,6 +1,6 @@
 <div class="row">
   <div class="col-md-2" align="center">
-    <a href="{{ site.swc_site }}"><img src="{{ site.root }}/assets/img/swc-icon-blue.svg" alt="Software Carpentry logo" /></a>
+    <a href="{{ site.swc_site }}"><img src="{{ site.github.url }}/assets/img/swc-icon-blue.svg" alt="Software Carpentry logo" /></a>
   </div>
   <div class="col-md-8">
     Since 1998,
@@ -14,7 +14,7 @@
 <br/>
 <div class="row">
   <div class="col-md-2" align="center">
-    <a href="{{ site.dc_site }}"><img src="{{ site.root }}/assets/img/dc-icon-black.svg" alt="Data Carpentry logo" /></a>
+    <a href="{{ site.dc_site }}"><img src="{{ site.github.url }}/assets/img/dc-icon-black.svg" alt="Data Carpentry logo" /></a>
   </div>
   <div class="col-md-8">
     <a href="{{ site.dc_site }}">Data Carpentry</a> develops and teaches workshops on the fundamental data skills needed to conduct research.

diff --git a/_includes/episode_title.html b/_includes/episode_title.html
@@ -3,22 +3,22 @@
   <div class="col-md-1">
     <h3>
       {% if prev_episode %}
-      <a href="{{ site.root }}{{ prev_episode.url }}"><span class="glyphicon glyphicon-menu-left"></span></a>
+      <a href="{{ site.github.url }}{{ prev_episode.url }}"><span class="glyphicon glyphicon-menu-left"></span></a>
       {% else %}
-      <a href="{{ site.root }}"><span class="glyphicon glyphicon-menu-up"></span></a>
+      <a href="{{ site.github.url }}"><span class="glyphicon glyphicon-menu-up"></span></a>
       {% endif %}
     </h3>
   </div>
   <div class="col-md-10">
-    <h3 class="maintitle"><a href="{{ site.root }}/">{{ site.title }}</a></h3>
+    <h3 class="maintitle"><a href="{{ site.github.url }}/">{{ site.title }}</a></h3>
     <h1 class="maintitle">{{ page.title }}</h1>
   </div>
   <div class="col-md-1">
     <h3>
       {% if next_episode %}
-      <a href="{{ site.root }}{{ next_episode.url }}"><span class="glyphicon glyphicon-menu-right"></span></a>
+      <a href="{{ site.github.url }}{{ next_episode.url }}"><span class="glyphicon glyphicon-menu-right"></span></a>
       {% else %}
-      <a href="{{ site.root }}"><span class="glyphicon glyphicon-menu-up"></span></a>
+      <a href="{{ site.github.url }}"><span class="glyphicon glyphicon-menu-up"></span></a>
       {% endif %}
     </h3>
   </div>

diff --git a/_includes/javascript.html b/_includes/javascript.html
@@ -1,12 +1,3 @@
-{% comment %}
-  If previewing locally, site.root is set in _config_dev.yml.
-  If site.root is not set, assume we're viewing on the web.
-{% endcomment %}
-{% if site.root %}
-  {% assign root = site.root %}
-{% else %}
-  {% assign root = site.github.url %}
-{% endif %}
-<script src="{{ root }}/assets/js/jquery.min.js"></script>
-<script src="{{ root }}/assets/js/bootstrap.min.js"></script>
-<script src="{{ root }}/assets/js/lesson.js"></script>
+<script src="{{ site.github.url }}/assets/js/jquery.min.js"></script>
+<script src="{{ site.github.url }}/assets/js/bootstrap.min.js"></script>
+<script src="{{ site.github.url }}/assets/js/lesson.js"></script>
diff --git a/_includes/lesson_footer.html b/_includes/lesson_footer.html
@@ -10,9 +10,9 @@
     </div>
     <div class="col-md-6" align="right">
       <h4>
-	<a href="{{ site.repo }}/">Source</a>
+	<a href="{{ site.github.repository_url }}/">Source</a>
 	/
-	<a href="{{ site.repo }}/blob/gh-pages/CONTRIBUTING.md">Contributing</a>
+	<a href="{{ site.github.repository_url }}/blob/gh-pages/CONTRIBUTING.md">Contributing</a>
 	/
 	<a href="mailto:{{ site.email }}">Contact</a>
       </h4>

diff --git a/_includes/main_title.html b/_includes/main_title.html
@@ -1 +1 @@
-<h1 class="maintitle"><a href="{{ site.root }}/">{{ site.title }}</a>{% if page.title %}: {{ page.title }}{% endif %}</h1>
+<h1 class="maintitle"><a href="{{ site.github.url }}/">{{ site.title }}</a>{% if page.title %}: {{ page.title }}{% endif %}</h1>
diff --git a/_includes/navbar.html b/_includes/navbar.html
@@ -1,12 +1,3 @@
-{% comment %}
-  If previewing locally, site.root is set in _config_dev.yml.
-  If site.root is not set, assume we're viewing on the web.
-{% endcomment %}
-{% if site.root %}
-  {% assign root = site.root %}
-{% else %}
-  {% assign root = site.github.url %}
-{% endif %}
 <nav class="navbar navbar-default">
   <div class="container-fluid">
     <div class="navbar-header">
@@ -20,60 +11,60 @@
       {% comment %} Select what logo to display. {% endcomment %}
       {% if page.carpentry == "swc" %}
       <a href="{{ site.swc_site }}" class="pull-left">
-        <img class="navbar-logo" src="{{ root }}/assets/img/swc-icon-blue.svg" alt="Software Carpentry logo" />
+        <img class="navbar-logo" src="{{ site.github.url }}/assets/img/swc-icon-blue.svg" alt="Software Carpentry logo" />
       </a>
       {% elsif page.carpentry == "dc" %}
       <a href="{{ site.dc_site }}" class="pull-left">
-        <img class="navbar-logo" src="{{ root }}/assets/img/dc-icon-black.svg" alt="Data Carpentry logo" />
+        <img class="navbar-logo" src="{{ site.github.url }}/assets/img/dc-icon-black.svg" alt="Data Carpentry logo" />
       </a>
       {% elsif site.carpentry == "swc" %}
       <a href="{{ site.swc_site }}" class="pull-left">
-        <img class="navbar-logo" src="{{ root }}/assets/img/swc-icon-blue.svg" alt="Software Carpentry logo" />
+        <img class="navbar-logo" src="{{ site.github.url }}/assets/img/swc-icon-blue.svg" alt="Software Carpentry logo" />
       </a>
       {% elsif site.carpentry == "dc" %}
       <a href="{{ site.dc_site }}" class="pull-left">
-        <img class="navbar-logo" src="{{ root }}/assets/img/dc-icon-black.svg" alt="Data Carpentry logo" />
+        <img class="navbar-logo" src="{{ site.github.url }}/assets/img/dc-icon-black.svg" alt="Data Carpentry logo" />
       </a>
       {% endif %}
 
       {% comment %} Always show link to home page. {% endcomment %}
-      <a class="navbar-brand" href="{{ root }}/">Home</a>
+      <a class="navbar-brand" href="{{ site.github.url }}/">Home</a>
 
     </div>
     <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
       <ul class="nav navbar-nav">
 
 	{% comment %} Always show code of conduct. {% endcomment %}
-        <li><a href="{{ root }}/conduct/">Code of Conduct</a></li>
+        <li><a href="{{ site.github.url }}/conduct/">Code of Conduct</a></li>
 
 	{% comment %} Show setup instructions, reference guide, and lesson episodes for lessons. {% endcomment %}
         {% if site.kind == "lesson" %}
-        <li><a href="{{ root }}/setup/">Setup</a></li>
-        <li><a href="{{ root }}/reference/">Reference</a></li>
+        <li><a href="{{ site.github.url }}/setup/">Setup</a></li>
+        <li><a href="{{ site.github.url }}/reference/">Reference</a></li>
         <li class="dropdown">
-          <a href="{{ root }}/" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Episodes <span class="caret"></span></a>
+          <a href="{{ site.github.url }}/" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Episodes <span class="caret"></span></a>
           <ul class="dropdown-menu">
             {% for episode in site.episodes %}
-            <li><a href="{{ root }}{{ episode.url }}">{{ episode.title }}</a></li>
+            <li><a href="{{ site.github.url }}{{ episode.url }}">{{ episode.title }}</a></li>
             {% endfor %}
           </ul>
         </li>
 	{% endif %}
 
 	{% comment %} Show extras for lessons or if this is the main workshop-template repo (where they contain documentation). {% endcomment %}
-	{% if site.kind == "lesson" or site.repository_name == "workshop-template" %}
+	{% if site.kind == "lesson" or site.github.repository_name == "workshop-template" %}
         <li class="dropdown">
-          <a href="{{ root }}/" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Extras <span class="caret"></span></a>
+          <a href="{{ site.github.url }}/" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Extras <span class="caret"></span></a>
           <ul class="dropdown-menu">
             {% for extra in site.extras %}
-            <li><a href="{{ root }}{{ extra.url }}">{{ extra.title }}</a></li>
+            <li><a href="{{ site.github.url }}{{ extra.url }}">{{ extra.title }}</a></li>
             {% endfor %}
           </ul>
         </li>
 	{% endif %}
 
 	{% comment %} Always show license. {% endcomment %}
-        <li><a href="{{ root }}/license/">License</a></li>
+        <li><a href="{{ site.github.url }}/license/">License</a></li>
       </ul>
       <form class="navbar-form navbar-right" role="search" id="search" onsubmit="google_search(); return false;">
         <div class="form-group">

diff --git a/_includes/syllabus.html b/_includes/syllabus.html
@@ -34,7 +34,7 @@
       {% if multiday %}<td class="col-md-1">{% if episode.start %}Day {{ day }}{% endif %}</td>{% endif %}
       <td class="col-md-1">{% if hours < 10 %}0{% endif %}{{ hours }}:{% if minutes < 10 %}0{% endif %}{{ minutes }}</td>
       <td class="col-md-3">
-        <a href="{{ site.root }}{{ episode.url }}">{{ episode.title }}</a>
+        <a href="{{ site.github.url }}{{ episode.url }}">{{ episode.title }}</a>
       </td>
       <td class="col-md-7">
         {% if episode.break %}

diff --git a/_layouts/base.html b/_layouts/base.html
@@ -1,25 +1,16 @@
 ---
 ---
-{% comment %}
-  If previewing locally, site.root is set in _config_dev.yml.
-  If site.root is not set, assume we're viewing on the web.
-{% endcomment %}
-{% if site.root %}
-  {% assign root = site.root %}
-{% else %}
-  {% assign root = site.github.url %}
-{% endif %}
 <!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta http-equiv="last-modified" content="{{ site.time }}">
     <meta name="viewport" content="width=device-width, initial-scale=1">
-    <meta name="search-domain" value="{{ root }}">
-    <link rel="stylesheet" type="text/css" href="{{ root }}/assets/css/bootstrap.css" />
-    <link rel="stylesheet" type="text/css" href="{{ root }}/assets/css/bootstrap-theme.css" />
-    <link rel="stylesheet" type="text/css" href="{{ root }}/assets/css/lesson.css" />
+    <meta name="search-domain" value="{{ site.github.url }}">
+    <link rel="stylesheet" type="text/css" href="{{ site.github.url }}/assets/css/bootstrap.css" />
+    <link rel="stylesheet" type="text/css" href="{{ site.github.url }}/assets/css/bootstrap-theme.css" />
+    <link rel="stylesheet" type="text/css" href="{{ site.github.url }}/assets/css/lesson.css" />
     {% if site.carpentry == "swc" %}
     <link rel="shortcut icon" type="image/x-icon" href="/favicon-swc.ico" />
     {% endif %}

diff --git a/_layouts/workshop.html b/_layouts/workshop.html
@@ -1,14 +1,5 @@
 ---
 ---
-{% comment %}
-  If previewing locally, site.root is set in _config_dev.yml.
-  If site.root is not set, assume we're viewing on the web.
-{% endcomment %}
-{% if site.root %}
-  {% assign root = site.root %}
-{% else %}
-  {% assign root = site.github.url %}
-{% endif %}
 <!doctype html>
 <html lang="en">
   <head>
@@ -34,9 +25,9 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta http-equiv="last-modified" content="{{ site.time }}">
     <meta name="viewport" content="width=device-width, initial-scale=1">
-    <link rel="stylesheet" type="text/css" href="{{ root }}/assets/css/bootstrap.css" />
-    <link rel="stylesheet" type="text/css" href="{{ root }}/assets/css/bootstrap-theme.css" />
-    <link rel="stylesheet" type="text/css" href="{{ root }}/assets/css/lesson.css" />
+    <link rel="stylesheet" type="text/css" href="{{ site.github.url }}/assets/css/bootstrap.css" />
+    <link rel="stylesheet" type="text/css" href="{{ site.github.url }}/assets/css/bootstrap-theme.css" />
+    <link rel="stylesheet" type="text/css" href="{{ site.github.url }}/assets/css/lesson.css" />
     {% if site.carpentry == "swc" %}
     <link rel="shortcut icon" type="image/x-icon" href="/favicon-swc.ico" />
     {% endif %}