Merge pull request #84 from 0xdevalias/jekyll-4-x-upgrade

Upgrade Jekyll to 4.x + associated cleanup

Author: 0xdevalias

.gitignore

@@ -5,3 +5,4 @@
 _site
 .jekyll-metadata
 .sass-cache
+.jekyll-cache/Jekyll

Gemfile

@@ -1,19 +1,26 @@
 source 'https://rubygems.org'
 
-gem 'jekyll','~>3.8.0'
-gem 'redcarpet'
+gem 'jekyll','~>4.1.0'
 
 # LSI (related posts)
-# Note: You need to install nmatrix and narray first, and/or export NMATRIX=1 NARRAY=1 before running bundle install, otherwise gsl won't use them
-gem 'narray'
+# Note: You need to install one of nmatrix or narray first, and export NMATRIX=1 or NARRAY=1 before running bundle install
+# otherwise gsl won't use them. Note that you can only use one or the other, not both.
+#   see https://github.com/SciRuby/rb-gsl#nmatrix-and-narray-usage
+#
+# Both of these seem to be extremely outdated, see:
+#   https://github.com/0xdevalias/devalias.net/issues/83
+#   https://github.com/jekyll/classifier-reborn/issues/192
+#   https://github.com/SciRuby/rb-gsl/issues/63
 gem 'nmatrix'
-gem 'gsl'
+gem 'gsl' # Note: you need to install a compatible version (eg. 2.1) of gsl first: brew install gsl@2.1
 gem 'classifier-reborn'
 
 group :jekyll_plugins do
-  gem 'jekyll-admin'
+  # gem 'jekyll-admin' # using outdated 1.4.x version of sinatra, see https://github.com/jekyll/jekyll-admin/issues/601
+  gem 'jekyll-commonmark'
   gem 'jekyll-compose'
   gem 'jekyll-paginate'
+  gem 'jekyll-postfiles'
   gem 'jekyll-redirect-from'
   gem 'jekyll-sitemap'
   gem 'jekyll-seo-tag'
@@ -24,7 +31,7 @@ group :jekyll_plugins do
   gem 'jekyll_version_plugin'
   gem 'jekyll-deploy'
   # gem 'jekyll-crosspost-to-medium'
-  gem 'jekyll-webmention_io'
+  # gem 'jekyll-webmention_io' # incompatible with jekyll 4, see https://github.com/aarongustafson/jekyll-webmention_io/issues/130
   gem 'jekyll-time-to-read'
   gem 'jekyll-twitter-plugin'
 end

Gemfile.lock

@@ -1,186 +1,132 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    backports (3.11.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    backports (3.18.1)
     classifier-reborn (2.2.0)
       fast-stemmer (~> 1.0)
     colorator (1.1.0)
-    concurrent-ruby (1.0.5)
-    domain_name (0.5.20180417)
-      unf (>= 0.0.5, < 1.0.0)
+    commonmarker (0.21.0)
+      ruby-enum (~> 0.5)
+    concurrent-ruby (1.1.6)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
-    eventmachine (1.2.5)
-    execjs (2.7.0)
-    faraday (0.15.0)
+    eventmachine (1.2.7)
+    faraday (1.0.1)
       multipart-post (>= 1.2, < 3)
     fast-stemmer (1.0.2)
-    ffi (1.9.23)
+    ffi (1.13.1)
     forwardable-extended (2.6.0)
     gsl (2.1.0.3)
-    htmlbeautifier (1.3.1)
-    http (2.2.2)
-      addressable (~> 2.3)
-      http-cookie (~> 1.0)
-      http-form_data (~> 1.0.1)
-      http_parser.rb (~> 0.6.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    http-form_data (1.0.3)
     http_parser.rb (0.6.0)
-    httparty (0.15.7)
-      multi_xml (>= 0.5.2)
-    i18n (0.9.5)
+    i18n (1.8.4)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.0)
+    jekyll (4.1.1)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
-      i18n (~> 0.7)
-      jekyll-sass-converter (~> 1.0)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
       jekyll-watch (~> 2.0)
-      kramdown (~> 1.14)
+      kramdown (~> 2.1)
+      kramdown-parser-gfm (~> 1.0)
       liquid (~> 4.0)
-      mercenary (~> 0.3.3)
+      mercenary (~> 0.4.0)
       pathutil (~> 0.9)
-      rouge (>= 1.7, < 4)
+      rouge (~> 3.0)
       safe_yaml (~> 1.0)
-    jekyll-admin (0.8.0)
-      addressable (~> 2.4)
-      jekyll (~> 3.3)
-      sinatra (~> 1.4)
-      sinatra-contrib (~> 1.4)
-    jekyll-compose (0.8.0)
-      jekyll (~> 3.0)
+      terminal-table (~> 1.8)
+    jekyll-commonmark (1.3.1)
+      commonmarker (~> 0.14)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-compose (0.12.0)
+      jekyll (>= 3.7, < 5.0)
     jekyll-deploy (0.0.2)
-    jekyll-feed (0.9.3)
-      jekyll (~> 3.3)
+    jekyll-feed (0.15.0)
+      jekyll (>= 3.7, < 5.0)
     jekyll-gist (1.5.0)
       octokit (~> 4.2)
-    jekyll-github-metadata (2.9.4)
-      jekyll (~> 3.1)
+    jekyll-github-metadata (2.13.0)
+      jekyll (>= 3.4, < 5.0)
       octokit (~> 4.0, != 4.4.0)
     jekyll-paginate (1.1.0)
-    jekyll-redirect-from (0.13.0)
-      jekyll (~> 3.3)
-    jekyll-sass-converter (1.5.2)
-      sass (~> 3.4)
-    jekyll-seo-tag (2.4.0)
-      jekyll (~> 3.3)
-    jekyll-sitemap (1.2.0)
-      jekyll (~> 3.3)
+    jekyll-postfiles (3.1.0)
+      jekyll (>= 3.8.6, < 5)
+    jekyll-redirect-from (0.16.0)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-sass-converter (2.1.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-seo-tag (2.6.1)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
     jekyll-time-to-read (0.1.2)
       jekyll
-    jekyll-twitter-plugin (2.0.0)
-    jekyll-watch (2.0.0)
+    jekyll-twitter-plugin (2.1.0)
+    jekyll-watch (2.2.1)
       listen (~> 3.0)
-    jekyll-webmention_io (2.9.1)
-      htmlbeautifier (~> 1.1)
-      http (~> 2.0)
-      jekyll (>= 2.0, < 4.0)
-      json (~> 2.0)
-      openssl (~> 2.0)
-      string_inflection (~> 0.1)
-      uglifier (~> 3.2)
-      webmention (~> 0.1.6)
     jekyll_version_plugin (2.0.0)
-    json (2.1.0)
-    kramdown (1.16.2)
-    link_header (0.0.8)
-    liquid (4.0.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    mercenary (0.3.6)
-    mini_portile2 (2.3.0)
-    multi_json (1.13.1)
-    multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    narray (0.6.1.2)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    multipart-post (2.1.1)
     nmatrix (0.2.4)
       packable (~> 1.3, >= 1.3.5)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    octokit (4.8.0)
+    octokit (4.18.0)
+      faraday (>= 0.9)
       sawyer (~> 0.8.0, >= 0.5.3)
-    openssl (2.1.0)
-    packable (1.3.9)
+    packable (1.3.14)
       backports
-    pathutil (0.16.1)
+    pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (3.0.2)
-    rack (1.6.9)
-    rack-protection (1.5.5)
-      rack
-    rack-test (1.0.0)
-      rack (>= 1.0, < 3)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    redcarpet (3.4.0)
-    rouge (3.1.1)
-    ruby_dep (1.5.0)
-    safe_yaml (1.0.4)
-    sass (3.5.6)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
-    sinatra (1.4.8)
-      rack (~> 1.5)
-      rack-protection (~> 1.4)
-      tilt (>= 1.3, < 3)
-    sinatra-contrib (1.4.7)
-      backports (>= 2.0)
-      multi_json
-      rack-protection
-      rack-test
-      sinatra (~> 1.4.0)
-      tilt (>= 1.3, < 3)
-    string_inflection (0.1.2)
-    tilt (2.0.8)
-    uglifier (3.2.0)
-      execjs (>= 0.3.0, < 3)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.5)
-    webmention (0.1.6)
-      httparty (~> 0.15.5)
-      json
-      link_header (~> 0.0.8)
-      nokogiri
+    public_suffix (4.0.5)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.4)
+    rouge (3.21.0)
+    ruby-enum (0.8.0)
+      i18n
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   classifier-reborn
   gsl
-  jekyll (~> 3.8.0)
-  jekyll-admin
+  jekyll (~> 4.1.0)
+  jekyll-commonmark
   jekyll-compose
   jekyll-deploy
   jekyll-feed
   jekyll-gist
   jekyll-github-metadata
   jekyll-paginate
+  jekyll-postfiles
   jekyll-redirect-from
   jekyll-seo-tag
   jekyll-sitemap
   jekyll-time-to-read
   jekyll-twitter-plugin
-  jekyll-webmention_io
   jekyll_version_plugin
-  narray
   nmatrix
-  redcarpet
 
 BUNDLED WITH
-   1.16.1
+   2.1.4

PUBLISHING.md

@@ -11,5 +11,5 @@ Some useful commands to remember:
 
 ## Build & Deploy
 
-* `jekyll build --lsi`
-* `jekyll deploy`
+* `bin/build`
+* `bin/deploy`

README.md

@@ -10,6 +10,11 @@ Feel free to create an issue/pull request for any typo's/bugs you might find :)
 
 * Link to other posts
     * `[other post]({% post_url 2017-01-01-other-post %})`
+* Embed an image with [jekyll-postfiles](https://github.com/nhoizey/jekyll-postfiles#how-does-it-work)
+  * create a folder under `_posts` named the same as your post's markdown file
+  * add any images for your post there, along with the post's markdown file
+  * use a relative markdown image tag to reference and embed the images
+    * eg. `![a title or something](foo.jpg)`
 * Embed a gist with [jekyll-gist](https://github.com/jekyll/jekyll-gist)
     * `{% gist foo/12345678901234567890 %} `
 * Embed a tweet with [jekyll-twitter-plugin](https://github.com/rob-murray/jekyll-twitter-plugin)

_config.yml

@@ -44,7 +44,7 @@ github_branch: 'master'
 #   base_url: https://twitter.com
 
 # https://github.com/jekyll/github-metadata
-repository: alias1/devalias.net
+repository: 0xdevalias/devalias.net
 
 #google_site_verification: ""
 # webmaster_verifications:
@@ -76,30 +76,26 @@ defaults:
       navigation: True
 
 # Conversion
-markdown: redcarpet
-redcarpet:
-  extensions:
-    - "tables"
-    - "autolink"
-    - "strikethrough"
-    - "space_after_headers"
-    #- "with_toc_data"
-    - "fenced_code_blocks"
+#   https://jekyllrb.com/docs/configuration/markdown/
+#   https://github.com/jekyll/jekyll-commonmark#configuration
+markdown: CommonMark
+
+commonmark:
+  options: ["UNSAFE", "FOOTNOTES", "STRIKETHROUGH_DOUBLE_TILDE", "VALIDATE_UTF8", "GITHUB_PRE_LANG", "HARDBREAKS"]
+  extensions: ["autolink", "strikethrough", "table", "tasklist"]
+
 lsi: false # Index for related posts (enabled by command line)
 
 keep_files:
   - .git
   - .nojekyll # To prevent GitHub re-processing
 
 exclude:
-  - "Gemfile"
-  - "Gemfile.lock"
   - "PUBLISHING.md"
   - "README.md"
   - "TODO.txt"
   - "ojekyll.txt"
   - "bin/"
-  - ".jekyll-cache/"
 
 # TODO: Enable these checks + fix any errors associated with them
 # liquid: