jekyll-generator-single-source 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e651ab73d6f998179bce7f5e714cb65a3de3395c3cbbd0a2e6537c811f805198
-  data.tar.gz: d31ec800b3b67e11c4f6dd7c54b1ffb2b7aa0a962322e0fbbfaf136142a3eb83
+  metadata.gz: 2aca19672cf3db42a62347e77ca5576f7e83c7044150ad7fa8f34425e39086e7
+  data.tar.gz: 8ed57306afbc005b1958ff14dc7819070d10c4dd575dc018fd2abcb1f9c7733b
 SHA512:
-  metadata.gz: 3c824783e55aa654214b2b12762fb6cddd07849c5fd8329336acadab5e95584f4faa26cee513f771efc7cda137203319f3d2ebb4c7f369b5c769ebbedeeb0a3f
-  data.tar.gz: 021f60ea8e4595e6ef4135f921eaa8758f3928005d37e09ec5d7cb38f2e25662ea09034e29c91c8b18985e2b7722f934938e9b6a0f2dd1fab5902958cbcbde12
+  metadata.gz: 9ed3e1fe6f04b3ff6d8f24e7be951998617b6d496752fdb5ca7d436d7759b81ee9f5c53f4e2475c03221237d351a4c122ae5d20351e860a2f5625a5e8a6ed4fd
+  data.tar.gz: 9551d769cfe366db6cf50a338435f5e2decb30c24c3bcc022d00b5c65b5b68749071c2b035bdd77eedb7c3fea554b4789dfe6d21948021f94601bc8a376baaec

data/README.md

@@ -11,13 +11,16 @@ end
 ```
 
 ## Usage
- 
+
+### Projects that have multiple products
 Add these lines to your site's `_config.yml`:
 
 ```yaml
 jekyll-generator-single-source:
   versions_file: '<path_to_versions_file>.yml'
   docs_nav_folder: '<path_to_folder_containing_doc_nav_files'
+  layout: 'docs-v2' # default value
+  multiple_products: true # default value
 ```
 
 The paths are relative to the site's  `source`.
@@ -28,4 +31,28 @@ Example configuration:
 jekyll-generator-single-source:
   versions_file: '_data/versions.yml'
   docs_nav_folder: '_data'
-```
+```
+
+### Projects with a single product
+
+Add these lines to your site's `_config.yml`:
+
+``` yaml
+jekyll-generator-single-source:
+  versions_file: '<path_to_versions_file>.yml'
+  docs_nav_folder: '<path_to_folder_containing_doc_nav_files'
+  layout: 'page'
+  multiple_products: false
+  base_dest_path: '<path_to_dest_folder_within_dist>'
+```
+
+Example configuration:
+
+``` yaml
+jekyll-generator-single-source:
+  versions_file: '_data/versions.yml'
+  docs_nav_folder: '_data'
+  layout: 'page'
+  multiple_products: false
+  base_dest_path: 'docs'
+```

data/lib/jekyll/generator-single-source/doc_nav_item/base.rb

@@ -62,6 +62,14 @@ module Jekyll
 
         private
 
+        def multiple_products?
+          GeneratorConfig.new(site).multiple_products?
+        end
+
+        def base_dest_path
+          GeneratorConfig.new(site).base_dest_path
+        end
+
         def source_path
           raise NotImplementedError.new('implement this in subclass')
         end

data/lib/jekyll/generator-single-source/doc_nav_item/src.rb

@@ -19,12 +19,20 @@ module Jekyll
           if src.start_with?('/')
             src
           else
-            [product, src].join('/')
+            if multiple_products?
+              [product, src].join('/')
+            else
+              src
+            end
           end
         end
 
         def dest_path
-          File.join(product, release, @item_config['url'], '/')
+          if multiple_products?
+            File.join(product, release, @item_config['url'], '/')
+          else
+            File.join(base_dest_path, release, @item_config['url'], '/')
+          end
         end
 
         def src

data/lib/jekyll/generator-single-source/doc_nav_item/without_src.rb

@@ -19,18 +19,34 @@ module Jekyll
         private
 
         def source_path
-          if product_page?
-            product
+          if multiple_products?
+            if product_page?
+              product
+            else
+              File.join(product, url.delete_prefix('/'))
+            end
           else
-            File.join(product, url.delete_prefix('/'))
+            if product_page?
+              'index'
+            else
+              File.join(url.delete_prefix('/'))
+            end
           end
         end
 
         def dest_path
-          if product_page?
-            File.join(product, release, '/')
+          if multiple_products?
+            if product_page?
+              File.join(product, release, '/')
+            else
+              File.join(product, release, url, '/')
+            end
           else
-            File.join(product, release, url, '/')
+            if product_page?
+              File.join(base_dest_path, release, '/')
+            else
+              File.join(base_dest_path, release, url, '/')
+            end
           end
         end
 

data/lib/jekyll/generator-single-source/generator.rb

@@ -5,26 +5,12 @@ module Jekyll
     class Generator < Jekyll::Generator
       priority :highest
 
-      attr_reader :config, :versions
-
-      def initialize(config = {})
-        @config = config.fetch('jekyll-generator-single-source', {})
-      end
-
       def generate(site)
-        Dir.glob(File.join(docs_nav_folder(site), 'docs_nav_*.yml')).each do |f|
-          DocNavConfig.new(f, site, versions(site)).generate_pages
-        end
-      end
-
-      def docs_nav_folder(site)
-        File.expand_path(@config.fetch('docs_nav_folder'), site.source)
-      end
+        config = GeneratorConfig.new(site)
 
-      def versions(site)
-        @versions ||= SafeYAML.load(
-          File.read(File.expand_path @config.fetch('versions_file'), site.source)
-        )
+        Dir.glob(File.join(config.docs_nav_folder, 'docs_nav_*.yml')).each do |f|
+          DocNavConfig.new(f, site, config.versions).generate_pages
+        end
       end
     end
   end

data/lib/jekyll/generator-single-source/generator_config.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module GeneratorSingleSource
+    class GeneratorConfig
+      CONFIG_KEY = 'jekyll-generator-single-source'
+
+      attr_reader :site
+
+      def initialize(site)
+        @site = site
+      end
+
+      def versions
+        @versions ||= SafeYAML.load(File.read(
+          File.expand_path(versions_file, @site.source)
+        ))
+      end
+
+      def layout
+        config['layout'] || 'docs-v2'
+      end
+
+      def versions_file
+        config['versions_file']
+      end
+
+      def docs_nav_folder
+        File.expand_path(config.fetch('docs_nav_folder'), @site.source)
+      end
+
+      def multiple_products?
+        !!config.fetch('multiple_products', true)
+      end
+
+      def base_dest_path
+        config['base_dest_path']
+      end
+
+      private
+
+      def config
+        @config ||= @site.config.fetch(CONFIG_KEY, {})
+      end
+    end
+  end
+end

data/lib/jekyll/generator-single-source/single_source_page.rb

@@ -35,7 +35,7 @@ module Jekyll
         @data['versions'] = nav_item.versions
 
         # Set the layout if it's not already provided
-        @data['layout'] ||= 'docs-v2'
+        @data['layout'] ||= GeneratorConfig.new(@site).layout
 
 
        # Apply any overrides

data/lib/jekyll/generator-single-source/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GeneratorSingleSource
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/lib/jekyll/generator-single-source.rb

@@ -8,6 +8,7 @@ require_relative 'generator-single-source/source/base'
 require_relative 'generator-single-source/source/dir_source'
 require_relative 'generator-single-source/source/file_source'
 require_relative 'generator-single-source/doc_nav_config'
+require_relative 'generator-single-source/generator_config'
 require_relative 'generator-single-source/generator'
 require_relative 'generator-single-source/single_source_page'
 require_relative 'generator-single-source/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-generator-single-source
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -91,6 +91,7 @@ files:
 - lib/jekyll/generator-single-source/doc_nav_item/without_src.rb
 - lib/jekyll/generator-single-source/doc_nav_item/without_src_and_url.rb
 - lib/jekyll/generator-single-source/generator.rb
+- lib/jekyll/generator-single-source/generator_config.rb
 - lib/jekyll/generator-single-source/hooks/version_is.rb
 - lib/jekyll/generator-single-source/liquid/tags/version_is.rb
 - lib/jekyll/generator-single-source/single_source_page.rb