Module: Shoreditch

Defined in:

lib/shoreditch.rb,
lib/shoreditch/icons.rb,
lib/shoreditch/version.rb

Overview

Inline SVG path data for the sidebar's contact panel.

Brand marks are from Simple Icons (https://simpleicons.org), CC0 1.0. They are vendored rather than pulled from a CDN so the theme keeps its no-external-dependency promise — the 0.9.0 version loaded a Font Awesome kit over the network on every page.

link is the fallback for any network with no bundled mark. LinkedIn uses it: Simple Icons removed that mark at the trademark holder's request, and shipping a lookalike would raise the same problem.

email, phone, file and link are drawn here — plain geometry, no marks.

Constant Summary

DEFAULTS =

Defaults a site can override in config/initializers.rb:

init :shoreditch do
accent "#c7254e"
sidebar_side "right"
end

{
  # Any CSS colour. Drives links, tag pills and focus rings.
  accent: "#4c7a9c",
  # "left" or "right" — which side the sidebar sits on at desk widths.
  sidebar_side: "left",
  # Shown under the logo. Set to nil to hide the badge entirely.
  logo_legend: nil,
  # "round" or "square".
  logo_shape: "round",
  # "round" or "straight" — the badge under the logo, shaped independently.
  logo_legend_shape: "round",
  # Comments, off by default. A hash of Giscus settings turns them on — see
  # components/shoreditch/comments.rb. Override that component to use any
  # other provider.
  comments: nil,
}.freeze

CSS_COLOUR =

A CSS colour we are willing to interpolate into a declaration: hex, an rgb()/hsl() function, or a bare keyword. Deliberately strict — accent comes from a site's config and is written straight into a