use site.github.url only in production
authorFrançois Michonneau <francois.michonneau@gmail.com>
Tue, 14 Aug 2018 21:58:44 +0000 (17:58 -0400)
committerFrançois Michonneau <francois.michonneau@gmail.com>
Tue, 14 Aug 2018 21:58:44 +0000 (17:58 -0400)
_layouts/base.html
bin/boilerplate/_config.yml

index 99d6567434a839aaeb0ad1f08f701c1483098af9..8a2e4b5134a8857d377f6bd7c2e7bc3a2cfaf119 100644 (file)
@@ -1,5 +1,21 @@
 ---
 ---
+
+{% comment %}
+When rendering websites locally, `site.github.url` doesn't get resolved
+properly unless GitHub PAT are set up and available in the environment.
+This leads to warnings and errors when trying to serve the site locally.
+To work around this, we use the `jekyll.environment` variable which is set to
+`development` when rendering the site locally, and set to `production` on
+GitHub where `site.github.url` will be defined.
+{% endcomment %}
+
+{% if jekyll.environment == "development" %}
+{% assign search_domain_url = "" %}
+{% elsif jekyll.environment == "production" %}
+{% assign search_domain_url = site.github.url  %}
+{% endif %}
+
 <!doctype html>
 <html lang="en">
   <head>
@@ -8,7 +24,7 @@
     <meta http-equiv="last-modified" content="{{ site.time }}">
     <meta name="viewport" content="width=device-width, initial-scale=1">
     <!-- meta "search-domain" used for google site search function google_search() -->
-    <meta name="search-domain" value="{{ site.github.url }}">
+    <meta name="search-domain" value="{{ search_domain_url }}">
     <link rel="stylesheet" type="text/css" href="{{ page.root }}/assets/css/bootstrap.css" />
     <link rel="stylesheet" type="text/css" href="{{ page.root }}/assets/css/bootstrap-theme.css" />
     <link rel="stylesheet" type="text/css" href="{{ page.root }}/assets/css/lesson.css" />
index 35e2cf1ccf4307e82414edb92e0d8ae58ba033b2..795a35c390ef52cffed2dc6bcc3c384eacde461f 100644 (file)
@@ -94,7 +94,3 @@ exclude:
 
 # Turn on built-in syntax highlighting.
 highlighter: rouge
-
-# Allow local rendering around github metadata
-# from: https://github.com/github/pages-gem/issues/399#issuecomment-301827749
-github: [metadata]