Module: Willamette

Defined in:
lib/willamette.rb,
lib/willamette/version.rb,
lib/willamette/builders/toc.rb,
lib/willamette/strategies/base.rb,
lib/willamette/strategies/link.rb,
lib/willamette/strategies/navbar.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.9.0"

Class Method Summary collapse

Class Method Details

rubocop:disable Metrics/ParameterLists



7
8
9
 
# File 'lib/willamette/strategies/link.rb', line 7

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

.links_for(base_resource) ⇒ Object 



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

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

.navbar(component, logo:, site_title:, nav_links:, logo_alt: "logo", search: true) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/willamette/strategies/navbar.rb', line 30

def self.navbar(
  component,
  logo:,
  site_title:,
  nav_links:,
  logo_alt: "logo",
  search: true
)
  Willamette::Strategies::Navbar.new(
    component, logo:, logo_alt:, site_title:, nav_links:, search:
  )
end

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/willamette/strategies/sidebar.rb', line 42

def self.sidebar(
  component,
  description: nil,
  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