Mark deprecation in docs, rebuild docs

Author: boardfish

docs/guide/templates.md

@@ -181,14 +181,18 @@ end
 
 Code editors commonly add a trailing newline character to source files in keeping with the Unix standard. Including trailing whitespace in component templates can result in unwanted whitespace in the HTML, eg. if the component is rendered before the period at the end of a sentence.
 
-To strip trailing whitespace from component templates, use the `strip_trailing_whitespace` class method.
+To strip trailing whitespace from component templates, use the `strip_trailing_whitespace` component-local config option.
 
 ```ruby
 class MyComponent < ViewComponent::Base
   # do strip whitespace
-  strip_trailing_whitespace
+  configure_component do |config|
+    config.strip_trailing_whitespace = true
+  end
 
   # don't strip whitespace
-  strip_trailing_whitespace(false)
+  configure_component do |config|
+    config.strip_trailing_whitespace = false
+  end
 end
 ```

lib/view_component/base.rb

@@ -611,21 +611,29 @@ def with_collection_parameter(parameter)
       # end
       # ```
       #
+      # @deprecated Use the new component-local configuration option instead.
+      #
+      #   ```ruby
+      #   class MyComponent < ViewComponent::Base
+      #     configure_component do |config|
+      #       config.strip_trailing_whitespace = true
+      #     end
+      #   end
+      #   ```
+      #
       # @param value [Boolean] Whether to strip newlines.
       def strip_trailing_whitespace(value = true)
         ViewComponent::Deprecation.deprecation_warning(
           "strip_trailing_whitespace",
-          %(
+          <<~DOC
             Use the new component-local configuration option instead:
 
-            ```rb
             class #{self.class.name} < ViewComponent::Base
               configure_view_component do |config|
                 config.strip_trailing_whitespace = #{value}
               end
             end
-            ```
-          )
+          DOC
         )
         view_component_config.strip_trailing_whitespace = value
       end

lib/view_component/docs_builder_component.html.erb

@@ -12,11 +12,11 @@ nav_order: 3
 ## <%= section.heading %>
 
 <% section.methods.each do |method| %>
-### <%== render ViewComponent::DocsBuilderComponent::MethodDoc.new(method, section.show_types) %>
+### <%= render ViewComponent::DocsBuilderComponent::MethodDoc.new(method, section.show_types) %>
 
 <% end %>
 <% section.error_klasses.each do |error_klass| %>
-### <%== render ViewComponent::DocsBuilderComponent::ErrorKlassDoc.new(error_klass, section.show_types) %>
+### <%= render ViewComponent::DocsBuilderComponent::ErrorKlassDoc.new(error_klass, section.show_types) %>
 
 <% end %>
 <% end %>

lib/view_component/docs_builder_component.rb

@@ -24,7 +24,7 @@ def error_message
       end
 
       def call
-        <<~DOCS.chomp
+        <<~DOCS.chomp.html_safe
           `#{klass_name}`
 
           #{error_message}
@@ -67,15 +67,15 @@ def deprecation_text
       end
 
       def docstring_and_deprecation_text
-        <<~DOCS.strip
+        <<~DOCS.strip.html_safe
           #{docstring}
 
           #{"_#{deprecation_text}_" if deprecated?}
         DOCS
       end
 
       def call
-        <<~DOCS.chomp
+        <<~DOCS.chomp.html_safe
           `#{separator}#{signature_or_name}`#{types}#{suffix}
 
           #{docstring_and_deprecation_text}