Class: Jekyll::GeneratorSingleSource::DocNavConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/jekyll/generator-single-source/doc_nav_config.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file_path, site, versions_from_file) ⇒ DocNavConfig

Returns a new instance of DocNavConfig.



8
9
10
11
12
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 8

def initialize(file_path, site, versions_from_file)
  @file_path = file_path
  @site      = site
  @versions_from_file  = versions_from_file
end

Instance Attribute Details

#file_path ⇒ Object (readonly)

Returns the value of attribute file_path.



6
7
8
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 6

def file_path
  @file_path
end

#site ⇒ Object (readonly)

Returns the value of attribute site.



6
7
8
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 6

def site
  @site
end

Instance Method Details

#assume_generated? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
21
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 18

def assume_generated?
  # Assume that the whole file should be treated as generated
  config['assume_generated'].nil? || config['assume_generated']
end

#generate_pages ⇒ Object 



42
43
44
45
46
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 42

def generate_pages
  return if skip_generation?

  items.map(&:generate_pages)
end

#items ⇒ Object 



23
24
25
26
27
28
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 23

def items
  @items ||= config.fetch('items', [])
    .concat([config['unlisted']])
    .flatten.compact
    .map { |i| DocNavItem::Base.make_for(i, self) }
end

#nav ⇒ Object 



48
49
50
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 48

def nav
  @nav ||= file_path
end

#product ⇒ Object 



30
31
32
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 30

def product
  @product ||= config['product']
end

#release ⇒ Object 



34
35
36
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 34

def release
  @release ||= config['release']
end

#skip_generation? ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 14

def skip_generation?
  !(config.is_a?(Hash) && config['generate'])
end

#versions ⇒ Object 



38
39
40
 
# File 'lib/jekyll/generator-single-source/doc_nav_config.rb', line 38

def versions
  @versions ||= Versions.extract(version)
end