docs-kit 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf583f1cfdfc22d788c0dcffac91b35a374138d8670cfe24bdef3cc2e05eb171
-  data.tar.gz: 7c3168bcaf1d0d1939350d704a12cb39f0e37a561be75a255517dcf82e531eba
+  metadata.gz: 51075e7a45365a86a3f97c35341cd2288ad35aba3f9ed1f4e31cea17edcacbfc
+  data.tar.gz: b5f49f3397f6b5d9090ee4560d82242a063a2cf8d0a7682c7a2fe7154364541f
 SHA512:
-  metadata.gz: 43c6f2f94b23ca4ad589a701f92121b3dcc3027cc06173432a653e215e9c4da2ab62e1a2044cf9ef3b1e19be9516d7a2698fc6b259f390ce3a15e5c2df50f6eb
-  data.tar.gz: 001253000ff36f16cd9ab76377cb4175dcab526a5a8dc2897fd0bde9809016d0dbd42fe5aa1e6474c24e7260eed25468843c393a4e73d447dc01f16c1a87b489
+  metadata.gz: 6b725ba25e7919148f89c6511300a0998e2d6d9d9539d84fa4c845cc8b933a24ba08c79131de936872000c4b56d787e8eeab17f9e46e8fbbe1a03a8b9d6eabf5
+  data.tar.gz: 11c6600410734838f11aa53957ccfeb89808996511e4b377e41b23e2d6f6afc23cee5cf161a44e12bb61c48e194843b09ed4550d4c341403b2806804f05bdf1e

data/CHANGELOG.md

@@ -18,6 +18,13 @@
 
 ### Added
 
+- **`DocsUI::Landing` hero logo (`c.landing.logo`).** The landing hero now takes
+  an optional brand mark above the eyebrow, in two forms: an inline single-path
+  SVG (`{ svg: "<path d>", viewbox:, label: }`, rendered with `fill: currentColor`
+  so it adapts to the theme) or an image (`{ src:, alt: }`, resolved through the
+  site's asset pipeline). nil (the default) omits it, so it's backwards-compatible.
+  This closes the gap a mounted docs app hit — a hero with no way to show the
+  product's own logo — the first consumer to try `DocsUI::Landing` on a real site.
 - **`DocsUI::Landing` — a config-driven marketing landing page.** Every consuming
   site (and this dogfood site) was hand-rolling a home page; now render
   `DocsUI::Landing` and drive it from a new `c.landing` config block

data/app/components/docs_ui/landing.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 module DocsUI
-  # The marketing landing page — a hero (eyebrow + title + lead + optional install
-  # snippet + CTA buttons), a feature-card grid, and a registry-grouped
-  # documentation index — rendered inside DocsUI::Shell. Every consuming site was
-  # hand-rolling this; drive it from config instead:
+  # The marketing landing page — a hero (an optional brand logo + eyebrow + title +
+  # lead + optional install snippet + CTA buttons), a feature-card grid, and a
+  # registry-grouped documentation index — rendered inside DocsUI::Shell. Every
+  # consuming site was hand-rolling this; drive it from config instead:
   #
   #   # config/initializers/docs_kit.rb
   #   DocsKit.configure do |c|
+  #     c.landing.logo     = { svg: "M4 2h9l5 5…Z", viewbox: "0 0 22 24", label: "Acme" }
   #     c.landing.eyebrow  = "Developer Docs"
   #     c.landing.title    = "Jobs & events on **Postgres**"   # ** ** → primary color
   #     c.landing.lead     = "PostgreSQL-native jobs + event bus for Rails."
@@ -30,6 +31,9 @@ module DocsUI
   # walks the same #docs-content region Shell stamps.
   class Landing < Phlex::HTML
     include Phlex::Rails::Helpers::Request
+    # For the image-form hero logo (c.landing.logo = { src: … }): resolve the asset
+    # path through the site's pipeline to its digested /assets URL.
+    include Phlex::Rails::Helpers::ImageURL
 
     def view_template
       render DocsUI::Shell.new(title: landing.eyebrow || config.brand) do
@@ -50,6 +54,7 @@ module DocsUI
 
     def hero
       div(class: "flex flex-col gap-6") do
+        logo
         eyebrow
         heading
         lead
@@ -58,6 +63,22 @@ module DocsUI
       end
     end
 
+    # The brand mark — an inline single-path SVG (currentColor, theme-adaptive) or
+    # an <img>. Rendered above the eyebrow, like a product wordmark.
+    def logo
+      return unless (mark = landing.hero_logo)
+
+      if mark.inline?
+        svg(viewbox: mark.viewbox, class: "h-9 w-auto text-primary", fill: "currentColor",
+            role: "img", aria_label: mark.label) do |s|
+          s.title { mark.label } if mark.label
+          s.path(d: mark.svg)
+        end
+      else
+        img(src: image_url(mark.src), alt: mark.alt.to_s, class: "h-9 w-auto")
+      end
+    end
+
     def eyebrow
       return unless (text = landing.eyebrow)
 

data/lib/docs_kit/landing_config.rb

@@ -26,6 +26,15 @@ module DocsKit
   # individually assignable in the `c.landing.x = ...` block, mirroring
   # DocsKit::SeoConfig.
   class LandingConfig
+    # An optional brand logo/mark rendered at the top of the hero (above the
+    # eyebrow), like a product wordmark. A Hash in one of two forms:
+    #   { svg: "<path d …>", viewbox: "0 0 81 45", label: "Brand" }  # inline mark
+    #   { src: "logo.svg", alt: "Brand" }                            # image asset/URL
+    # The inline `svg` form renders with `fill: currentColor` so it adapts to the
+    # theme (light/dark) — best for a single-color mark. nil omits the logo.
+    # See #hero_logo (the normalized Logo value object) and DocsUI::Landing.
+    attr_writer :logo
+
     # A small uppercase kicker above the title (e.g. "Developer Docs"). nil omits it.
     attr_accessor :eyebrow
 
@@ -81,6 +90,13 @@ module DocsKit
       { code: attrs[:code].to_s, filename: attrs[:filename], lexer: (attrs[:lexer] || :shell).to_sym }
     end
 
+    # The hero logo as a normalized Logo value object, or nil when unset.
+    def hero_logo
+      return if @logo.nil?
+
+      Logo.from(@logo)
+    end
+
     # One hero call-to-action button. `style` maps to a daisyUI btn variant
     # (:primary → btn-primary, anything else → btn-ghost). `icon` is an optional
     # brand/lucide token rendered before the label (DocsUI::BrandMark resolves it).
@@ -117,5 +133,28 @@ module DocsKit
         new(icon: attrs[:icon], title: attrs[:title], body: attrs[:body])
       end
     end
+
+    # The hero brand logo — either an inline single-path SVG mark (`svg` = the
+    # `<path d>` data, `viewbox` = its viewBox) rendered with fill: currentColor so
+    # it adapts to the theme, OR an image (`src` = an asset path/URL, `alt` = its
+    # accessible name). `label` is the accessible name for the inline mark.
+    Logo = Data.define(:svg, :viewbox, :src, :alt, :label) do
+      def initialize(svg: nil, viewbox: "0 0 24 24", src: nil, alt: nil, label: nil)
+        super
+      end
+
+      def self.from(logo)
+        return logo if logo.is_a?(self)
+
+        attrs = logo.to_h.transform_keys(&:to_sym)
+        new(
+          svg: attrs[:svg], viewbox: attrs[:viewbox] || "0 0 24 24",
+          src: attrs[:src], alt: attrs[:alt], label: attrs[:label]
+        )
+      end
+
+      # An inline SVG mark (vs. an <img>). True when `svg` path data is present.
+      def inline? = !svg.to_s.empty?
+    end
   end
 end

data/lib/docs_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DocsKit
-  VERSION = "1.0.5"
+  VERSION = "1.0.6"
 end

data/lib/generators/docs_kit/install/templates/docs_kit.rb.erb

@@ -109,6 +109,9 @@ Rails.application.config.to_prepare do
     # knobs. Every field is optional; with none set it still renders a minimal hero
     # (the brand + the doc index). Wrap a run in **double asterisks** to accent it
     # in the primary color.
+    # c.landing.logo = { svg: "M4 2h9l5 5…Z", viewbox: "0 0 22 24", label: "<%= app_brand %>" }
+    #   # ^ an inline single-path SVG mark (fill: currentColor, theme-adaptive), OR
+    #   #   an image: { src: "logo.svg", alt: "<%= app_brand %>" }
     # c.landing.eyebrow = "Developer Docs"
     # c.landing.title   = "The <%= app_brand %> **API**"
     # c.landing.lead    = "One sentence on what your product does."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docs-kit
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Mikael Henriksson