Module: Willamette

Defined in:
lib/willamette.rb,
lib/willamette/version.rb,
lib/willamette/builders/toc.rb,
lib/willamette/strategies/link.rb,
lib/willamette/strategies/sidebar.rb,
lib/willamette/builders/inspectors.rb,
lib/willamette/builders/author_extension.rb

Defined Under Namespace

Modules: Builders, Strategies

Constant Summary collapse

VERSION = 
"0.6.0"

Class Method Summary collapse

Class Method Details

rubocop:disable Metrics/ParameterLists



5
6
7
 
# File 'lib/willamette/strategies/link.rb', line 5

def self.link(depth: 1, current: false, icon: nil, icon_family: nil, **) # rubocop:disable Metrics/ParameterLists
  Strategies::Link.new(depth:, current:, icon:, icon_family:, **)
end

.links_for(base_resource) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/willamette/strategies/link.rb', line 9

def self.links_for(base_resource)
  base_resource.collection.map do |resource|
    depth = resource.relative_path.each_filename.count - 1
    Willamette.link(
      current: resource == base_resource,
      title: resource.data.title,
      url: resource.relative_url,
      depth:
    )
  end
end

.sidebar(component, description:, explore_links: nil, follow_links: nil, subscribe: false, see_also_links: nil) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/willamette/strategies/sidebar.rb', line 70

def self.sidebar(
  component,
  description:,
  explore_links: nil,
  follow_links: nil,
  subscribe: false,
  see_also_links: nil
)
  Willamette::Strategies::Sidebar.new(
    component, description:, explore_links:, follow_links:, subscribe:, see_also_links:
  )
end