[SVN] r2726 www.twisterrob.net in /Web/www.twisterrob.net/

[MOD] Update to latest Jekyll (gh-pages gem 193)

Author: TWiStErRob

Gemfile

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
 # for some reason omitting the version defaults to 0
-gem 'github-pages', '>= 127'
+gem 'github-pages', '= 193', group: :jekyll_plugins
 
 # http://jekyllrb.com/docs/windows/#auto-regeneration
 # for --watch to work on Windows

README.md

@@ -33,14 +33,63 @@ me@windows$ gradle serve dev noskip
 ```
 
 ## Usage
-Update dependencies occasionally by
-
-```shell
-me@website$ bundle update
-```
 
 Check if site build successfully before each commit
 
 ```shell
 me@webiste$ gradle preCommitServe local
 ```
+
+## Upgrade
+
+ * Change `gem 'github-pages'` version to [GitHub version](https://pages.github.com/versions/)
+ * `bundle update`, watch for these two lines:
+   > Fetching github-pages 192 (was 127)
+   > Fetching jekyll 3.7.4 (was 3.4.1)
+ * Read release notes for missed versions:
+   * https://github.com/github/pages-gem/releases
+   * https://jekyllrb.com/news/releases/  
+     https://jekyllrb.com/docs/history/
+   * Watch out for Liquid updates
+   * Watch out for Ruby updates
+ * Check if https://help.github.com/articles/configuring-jekyll/#configuration-settings-you-cannot-change has changed
+
+## TODO
+
+GHPages:
+	161 Whitelist jekyll-octicons (#483) https://github.com/github/pages-gem/pull/483
+	86-192: rouge 1.11.1 -> 2.2.1
+	kramdown 1.13.2 -> 1.17.0
+Jekyll 3.5
+	Sitemaps for static files
+	Liquid 4: https://github.com/Shopify/liquid/blob/master/History.md#400--2016-12-14--branch-4-0-stable
+	Jekyll now uses Liquid 4, the latest! It comes with whitespace control, new filters concat and compact, loop performance improvements and many fixes
+	Pages, posts, and other documents can now access layout variables via  {{ layout }}.
+	The gems key in the _config.yml is now plugins.
+	Filters like sort now allow you to sort based on a subvalue, e.g. {% assign sorted = site.posts | sort: "image.alt_text" %}.
+	layout: null -> layout: none (null = default, none = no layout)
+Jekyll 3.6
+	Rouge 2 support, but note you can continue to use Rouge 1
+Jekyll 3.7
+	--livereload
+	slugify latin
+	collections folder (https://jekyllrb.com/docs/collections/)
+	Ruby 2.5.3
+
+Finished reading news <3.8 and changelog <=3.8
+
+these two end up in sitemap after update
+/dev/assets/css/style.css
+/dev/redirects.json
+
+dev > sass > line_numbers: true is broken after update (generated CSS files no longer have line numbers)
+ref https://github.com/jekyll/jekyll-sass-converter/blob/master/lib/jekyll/converters/scss.rb#L48
+
+dev > sass > sourcemap is disabled, check if it can be enabled
+
+new RegExp('vegetarian is broken in javascript, report backslash issue
+contact wasn't working, now it is? (probably should be generated in debug)
+shell code formatting lost user@machine$ formatting
+
+https://github.com/jekyll/jekyll/pull/6384/files#diff-514abd885acda367325e5236a9be3192R68
+https://github.com/kacperduras/disqus-for-jekyll

_config.yml

@@ -59,7 +59,7 @@ whitelist:
   - jekyll-gist
   - jemoji
 
-gems:
+plugins:
 # !github-pages! optional › https://github.com/github/pages-gem/blob/jekyll-v3-4-2/lib/github-pages/plugins.rb#L6-L16
 # paginate and paginate_path in _config is used
   - jekyll-paginate
@@ -85,11 +85,11 @@ paginate: 10
 # Pagination path › Important for blog page in /blog/ to work
 paginate_path: "/blog/page:num/"
 
-# !github-pages! mandatory › https://help.github.com/articles/using-jekyll-with-pages/#configuration-settings-you-cannot-change
+# !github-pages! mandatory › https://help.github.com/articles/configuring-jekyll/#configuration-settings-you-cannot-change
 # Disables custom plugins and ignore symbolic links
 # This means that ```java will not work because it requires https://github.com/mvdbos/kramdown-with-pygments
 safe: true
-# !github-pages! mandatory provided › https://help.github.com/articles/using-jekyll-with-pages/#configuration-settings-you-cannot-change
+# !github-pages! mandatory provided › https://help.github.com/articles/configuring-jekyll/#configuration-settings-you-cannot-change
 #source: '.' # auto-set
 
 # Include/Exclude these files from production _site
@@ -140,7 +140,7 @@ excerpt_separator: "<!--more-->"
 
 # Theme works best with Kramdown (using the table of contents function)
 markdown: kramdown
-# !github-pages! mandatory › https://help.github.com/articles/using-jekyll-with-pages/#configuration-settings-you-cannot-change
+# !github-pages! mandatory › https://help.github.com/articles/configuring-jekyll/#configuration-settings-you-cannot-change
 # Since Jekyll 3 the default highlighter is Rouge (replaced Pygments.rb in v44)
 highlighter: rouge
 
@@ -157,16 +157,22 @@ kramdown:
   toc_panel:      true
   smart_quotes:   lsquo,rsquo,ldquo,rdquo
   hard_wrap:      false
+  # !github-pages! mandatory › https://help.github.com/articles/configuring-jekyll/#configuration-settings-you-cannot-change
   # https://github.com/jekyll/jekyll/pull/4090
   syntax_highlighter: rouge
+  # !github-pages! mandatory › https://help.github.com/articles/configuring-jekyll/#configuration-settings-you-cannot-change
+  math_engine: mathjax
+  show_warnings: true
 
   # Rouge Highlighter in Kramdown › http://kramdown.gettalong.org/syntax_highlighter/rouge.html
   # span, block element options fall back to global
   syntax_highlighter_opts:
     # Rouge Options › https://github.com/jneen/rouge#full-options
     #debug: false
     #parent: ''
-    css_class: 'highlight'
+    # Affects <pre class>, but not <div class> around <pre>
+    # disabled to prevent problems with CSS due to .highlight > .highlight structure
+    css_class: ''
     default_lang: text
     disable: false
     span:
@@ -178,14 +184,15 @@ kramdown:
       disable: false
 
 # More › http://sass-lang.com
-# Options › http://jekyllrb.com/docs/assets/#sassscss
+# Docs › http://jekyllrb.com/docs/assets/#sassscss
+# Options › http://sass-lang.com/documentation/file.SASS_REFERENCE.html#options
 # Safe mode only allows style, syntax=based on extension, cache=false
 sass:
   sass_dir: _sass
   # Options › http://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style
   style: :compressed # :nested | :expanded | :compact | :compressed
 
-# Used › default.html front-matter and comress.html
+# Used › default.html front-matter and compress.html
 # Options › http://jch.penibelst.de
 compress_html:
   clippings: all
@@ -197,10 +204,9 @@ compress_html:
   ignore:
     envs: [development]
 
-# !github-pages! mandatory › https://help.github.com/articles/using-jekyll-with-pages/#configuration-settings-you-cannot-change
-# Since Jekyll 3 the default highlighter is Rouge (replaced Pygments.rb in v44)
+# !github-pages! mandatory › https://help.github.com/articles/configuring-jekyll/#configuration-settings-you-cannot-change
 incremental: false
-# !github-pages! mandatory › https://help.github.com/articles/using-jekyll-with-pages/#configuration-settings-you-cannot-change
+# !github-pages! mandatory › https://help.github.com/articles/configuring-jekyll/#configuration-settings-you-cannot-change
 # TODO what is this?
 lsi: false
 
@@ -352,7 +358,7 @@ google_analytics_tracking_id: UA-38202353-4
 #tawkto_embed_uri: https://embed.tawk.to/<id>/default<script>
 
 gist:
-  # !github-pages! mandatory › https://help.github.com/articles/using-jekyll-with-pages/#configuration-settings-you-cannot-change
+  # !github-pages! mandatory › https://help.github.com/articles/configuring-jekyll/#configuration-settings-you-cannot-change
   noscript: false
 
 # !github-pages! provided › https://help.github.com/articles/repository-metadata-on-github-pages/

_config_dev.yml

@@ -19,10 +19,9 @@ unpublished: true
 future: true
 
 sass:
-  # http://sass-lang.com/documentation/file.SASS_REFERENCE.html#output_style
   style: :expanded
   line_numbers: true
   #trace_selectors: true
   #debug_info: true
   # FUTURE https://github.com/jekyll/jekyll-sass-converter/issues/12
-  sourcemap: true
+  #sourcemap: true