auto generate descriptions

KonnorRogers · Oct 14, 2023 · b53fe8a · b53fe8a
1 parent 2eca84f
commit b53fe8a
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 6 deletions.
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -41,7 +41,7 @@ gem "asset_mapper", "~> 1.0"
 
 gem "rack-cors", "~> 2.0"
 
-gem "custom_elements_manifest_parser", "~> 0.2.1"
+gem "custom_elements_manifest_parser", "~> 0.2.4"
 
 gem "ruby-lsp", "~> 0.11.1", :group => :development, require: false
 gem "yard", "~> 0.9.34", :group => :development

diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -56,7 +56,7 @@ GEM
       bridgetown (>= 1.2.0.beta2, < 2.0)
     colorator (1.1.0)
     concurrent-ruby (1.2.2)
-    custom_elements_manifest_parser (0.2.2)
+    custom_elements_manifest_parser (0.2.4)
       dry-struct (~> 1.0)
       dry-types (~> 1.0)
       dry-validation (~> 1.0)
@@ -228,7 +228,7 @@ DEPENDENCIES
   asset_mapper (~> 1.0)
   bridgetown (~> 1.3)
   bridgetown-quick-search (~> 2.0)
-  custom_elements_manifest_parser (~> 0.2.1)
+  custom_elements_manifest_parser (~> 0.2.4)
   debug (~> 1.8)
   nokogiri (~> 1.13)
   puma (~> 5.6)

diff --git a/docs/plugins/builders/component_generator.rb b/docs/plugins/builders/component_generator.rb
@@ -19,6 +19,10 @@ def build
         metadata = elements[component_name]
         next if metadata.nil?
 
+        resource.data.merge!({
+          "description" => metadata.description
+        })
+
         slots = metadata.slots
         attributes = metadata.members.select { |member| member.attributes[:attribute] }
         events = metadata.events

diff --git a/docs/src/_documentation/components/light-preview.md b/docs/src/_documentation/components/light-preview.md
@@ -1,9 +1,6 @@
 ---
 title: <light-preview>
 permalink: /components/light-preview/
-description: |
-  A lightweight code previewing component designed to show source code side by side with
-  a demo of your code in the browser.
 ---
 
 ## Typical Usage