Module: Jekyll::OpenProjectHelpers

Defined in:
lib/jekyll-theme-open-project-helpers.rb,
lib/jekyll-theme-open-project-helpers/site_type.rb,
lib/jekyll-theme-open-project-helpers/blog_index.rb,
lib/jekyll-theme-open-project-helpers/filterable_index.rb,
lib/jekyll-theme-open-project-helpers/project_data_reader.rb,
lib/jekyll-theme-open-project-helpers/spec_builders/spec_builder.rb

Defined Under Namespace

Classes: CollectionDocReader, CombinedPostArrayGenerator, FilteredIndexPage, FilteredIndexPageGenerator, IndexPageGenerator, NonLiquidDocument, OpenProjectReader, SiteTypeVariableGenerator, SpecBuilder

Constant Summary collapse

INDEXES =

On an open hub site, Jekyll Open Project theme assumes the existence of two types of item indexes: software and specs, where items are gathered from across open projects in the hub.

The need for :item_test arises from our data structure (see Jekyll Open Project theme docs) and the fact that Jekyll doesn’t intuitively handle nested collections.

{
  "software" => {
    :item_test => lambda { |item| item.path.include? '/_software' and not item.path.include? '/docs' },
  },
  "specs" => {
    :item_test => lambda { |item| item.path.include? '/_specs' and not item.path.include? '/docs' },
  },
}
DEFAULT_DOCS_SUBTREE =
'docs'
DEFAULT_REPO_REMOTE_NAME =
'origin'
DEFAULT_REPO_BRANCH =
'master'