Przeglądaj źródła

Update Jekyll documentation

Phil Scherer 5 lat temu
rodzic
commit
e0100dd133

+ 1 - 1
assets/javascripts/templates/pages/about_tmpl.coffee

@@ -378,7 +378,7 @@ credits = [
     'https://raw.githubusercontent.com/jasmine/jasmine/master/MIT.LICENSE'
   ], [
     'Jekyll',
-    '2008-2018 Tom Preston-Werner and Jekyll contributors',
+    '2020 Jekyll Core Team and contributors',
     'MIT',
     'https://raw.githubusercontent.com/jekyll/jekyll/master/LICENSE'
   ], [

+ 30 - 4
lib/docs/filters/jekyll/entries.rb

@@ -1,13 +1,35 @@
 module Docs
   class Jekyll
     class EntriesFilter < Docs::EntriesFilter
+      # Information for which high-level category a page belongs to only exists
+      # on the first level hierarchy. Beyond that, we have to use slug.
+      TYPE_BY_DIR = {
+        'installation' => 'Getting Started',
+        'community' => 'Getting Started',
+
+        'usage' => 'Build',
+        'configuration' => 'Build',
+        'rendering-process' => 'Build',
+
+        'liquid' => 'Site Structure',
+
+        'plugins' => 'Guides',
+        'deployment' => 'Guides',
+
+        'continuous-integration' => 'Deployment'
+      }
+
       def get_name
-        at_css('h1').content
+        if slug.split('/').first == 'step-by-step'
+          at_css('h2').content
+        else
+          at_css('h1').content
+        end
       end
 
       def get_type
-        if slug.include?('continuous-integration')
-          'Deployment'
+        if slug.split('/').first == 'step-by-step'
+          'Tutorial'
         else
           nav_link = doc.document # document
             .at_css('aside li.current') # item in navbar
@@ -18,7 +40,11 @@ module Docs
               .previous_element # header before <ul>
               .content # category
           else
-            'Miscellaneous'
+            if TYPE_BY_DIR.key?(slug.split('/').first)
+              TYPE_BY_DIR[slug.split('/').first]
+            else
+              'Miscellaneous'
+            end
           end
         end
       end

+ 4 - 5
lib/docs/scrapers/jekyll.rb

@@ -1,9 +1,9 @@
 module Docs
   class Jekyll < UrlScraper
     self.type = 'jekyll'
-    self.release = '3.7.2'
+    self.release = '4.1.1'
     self.base_url = 'https://jekyllrb.com/docs/'
-    self.root_path = 'home/'
+    self.root_path = 'index.html'
     self.links = {
       home: 'https://jekyllrb.com/',
       code: 'https://github.com/jekyll/jekyll'
@@ -20,12 +20,11 @@ module Docs
       /contributing/,
     ]
     options[:replace_paths] = {
-      '' => 'home/',
-      '/' => 'home/'
+      'templates/' => 'liquid/'
     }
 
     options[:attribution] = <<-HTML
-      &copy; 2008&ndash;2018 Tom Preston-Werner and Jekyll contributors<br>
+      &copy; 2020 Jekyll Core Team and contributors<br>
       Licensed under the MIT license.
     HTML