jekyll-generator-single-source

Installation

Add this line to your site's Gemfile:

group :jekyll_plugins do
  gem 'jekyll-generator-single-source'
end

Usage

Projects that have multiple products

Add these lines to your site's _config.yml:

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.

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:

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:

jekyll-generator-single-source:
  versions_file: '_data/versions.yml'
  docs_nav_folder: '_data'
  layout: 'page'
  multiple_products: false
  base_dest_path: 'docs'