Add "Offline" Capable

This is based on carpentries#127.
maxim-belkin · Nov 5, 2017 · 5aaa87a · 5aaa87a
1 parent 5edc669
commit 5aaa87a
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 19 deletions.
diff --git a/_includes/main_title.html b/_includes/main_title.html
@@ -1,4 +1,4 @@
 {% comment %}
   Main title for lesson pages.
 {% endcomment %}
-<h1 class="maintitle"><a href="{{ page.root }}/">{{ site.title }}</a>{% if page.title %}: {{ page.title }}{% endif %}</h1>
+<h1 class="maintitle"><a href="{{ page.root }}{% link index.md %}">{{ site.title }}</a>{% if page.title %}: {{ page.title }}{% endif %}</h1>
diff --git a/_includes/navbar.html b/_includes/navbar.html
@@ -12,41 +12,43 @@
       </button>
 
       {% comment %} Select what logo to display. {% endcomment %}
-      {% if site.carpentry == "swc" %}
+      {% if page.carpentry == "swc" %}
       <a href="{{ site.swc_site }}" class="pull-left">
         <img class="navbar-logo" src="{{ page.root }}/assets/img/swc-icon-blue.svg" alt="Software Carpentry logo" />
       </a>
-      {% elsif site.carpentry == "dc" %}
+      {% elsif page.carpentry == "dc" %}
       <a href="{{ site.dc_site }}" class="pull-left">
         <img class="navbar-logo" src="{{ page.root }}/assets/img/dc-icon-black.svg" alt="Data Carpentry logo" />
       </a>
-      {% elsif site.carpentry == "lc" %}
+      {% elsif page.carpentry == "lc" %}
       <a href="{{ site.lc_site }}" class="pull-left">
         <img class="navbar-logo" src="{{ page.root }}/assets/img/lc-icon-black.png" alt="Library Carpentry logo" />
       </a>
       {% endif %}
 
       {% comment %} Always show link to home page. {% endcomment %}
-      <a class="navbar-brand" href="{{ page.root }}/">Home</a>
+      <a class="navbar-brand" href="{{ page.root }}{% link index.md %}">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="{{ page.root }}/conduct/">Code of Conduct</a></li>
+        <li><a href="{{ page.root }}{% link CONDUCT.md %}">Code of Conduct</a></li>
 
-	{% comment %} Show setup instructions, reference guide, and lesson episodes for lessons. {% endcomment %}
         {% if site.kind == "lesson" %}
-        <li><a href="{{ page.root }}/setup/">Setup</a></li>
+	{% comment %} Show setup instructions. {% endcomment %}
+        <li><a href="{{ page.root }}{% link setup.md %}">Setup</a></li>
+
+        {% comment %} Show lesson episodes for lessons. {% endcomment %}
         <li class="dropdown">
           <a href="{{ page.root }}/" 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="{{ page.root }}{{ episode.url }}">{{ episode.title }}</a></li>
             {% endfor %}
 	    <li role="separator" class="divider"></li>
-            <li><a href="{{ page.root }}/aio/">All in one page (Beta)</a></li>
+            <li><a href="{{ page.root }}{% link aio.md %}">All in one page (Beta)</a></li>
           </ul>
         </li>
 	{% endif %}
@@ -56,7 +58,7 @@
         <li class="dropdown">
           <a href="{{ page.root }}/" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">Extras <span class="caret"></span></a>
           <ul class="dropdown-menu">
-            <li><a href="{{ page.root }}/reference/">Reference</a></li>
+            <li><a href="{{ page.root }}{% link reference.md %}">Reference</a></li>
             {% for extra in site.extras %}
             <li><a href="{{ page.root }}{{ extra.url }}">{{ extra.title }}</a></li>
             {% endfor %}
@@ -65,7 +67,7 @@
 	{% endif %}
 
 	{% comment %} Always show license. {% endcomment %}
-        <li><a href="{{ page.root }}/license/">License</a></li>
+        <li><a href="{{ page.root }}{% link LICENSE.md %}">License</a></li>
 	{% if page.source %}
 	{% if page.source == "Rmd" %}
 	<li><a href="{{site.github.repository_url}}/edit/gh-pages/{{page.path|replace: "_episodes", "_episodes_rmd" | replace: ".md", ".Rmd"}}">Improve this page <span class="glyphicon glyphicon-pencil" aria-hidden="true"></span></a></li>

diff --git a/bin/lesson_initialize.py b/bin/lesson_initialize.py
@@ -222,9 +222,10 @@
 collections:
   episodes:
     output: true
-    permalink: /:path/
+    permalink: /:path/index.html
   extras:
     output: true
+    permalink: /:path/index.html
 
 # Set the default layout for things in the episodes collection.
 defaults:
@@ -249,6 +250,7 @@
 ---
 layout: lesson
 root: .
+permalink: index.html  # Is the only page that don't follow the partner /:path/index.html
 ---
 FIXME: home page introduction
 
@@ -261,7 +263,6 @@
 ROOT_REFERENCE_MD = '''\
 ---
 layout: reference
-permalink: /reference/
 ---
 
 ## Glossary
@@ -273,15 +274,13 @@
 ---
 layout: page
 title: Setup
-permalink: /setup/
 ---
 FIXME
 '''
 
 ROOT_AIO_MD = '''\
 ---
 layout: page 
-permalink: /aio/
 ---
 <script>
   window.onload = function() {
@@ -335,7 +334,6 @@
 ---
 layout: page
 title: About
-permalink: /about/
 ---
 {% include carpentries.html %}
 '''
@@ -344,7 +342,6 @@
 ---
 layout: page
 title: Discussion
-permalink: /discuss/
 ---
 FIXME
 '''
@@ -353,7 +350,6 @@
 ---
 layout: page
 title: Figures
-permalink: /figures/
 ---
 {% include all_figures.html %}
 '''
@@ -362,7 +358,6 @@
 ---
 layout: page
 title: "Instructor Notes"
-permalink: /guide/
 ---
 FIXME
 '''