Class: LlmDocsBuilder::Transformers::ContentCleanupTransformer

Inherits:
Object
  • Object
show all
Includes:
BaseTransformer
Defined in:
lib/llm_docs_builder/transformers/content_cleanup_transformer.rb

Overview

Transformer for content cleanup operations

Handles removal of various markdown elements that don’t provide value for LLM consumption (frontmatter, comments, badges, etc.).

Instance Method Summary collapse

Methods included from BaseTransformer

#should_transform?

Instance Method Details

#transform(content, options = {}) ⇒ String

Transform content by removing unwanted elements

Parameters:

  • content (String) —

    markdown content

  • options (Hash) (defaults to: {}) —

    transformation options

Options Hash (options):

  • :remove_frontmatter (Boolean) —

    remove YAML/TOML frontmatter

  • :remove_comments (Boolean) —

    remove HTML comments

  • :remove_badges (Boolean) —

    remove badge images

  • :remove_code_examples (Boolean) —

    remove code blocks

  • :remove_images (Boolean) —

    remove image syntax

  • :remove_blockquotes (Boolean) —

    remove blockquote formatting

Returns:

  • (String) —

    transformed content



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/llm_docs_builder/transformers/content_cleanup_transformer.rb', line 25

def transform(content, options = {})
  result = content.dup

  result = remove_frontmatter(result) if options[:remove_frontmatter]
  result = remove_comments(result) if options[:remove_comments]
  result = remove_badges(result) if options[:remove_badges]
  result = remove_code_examples(result) if options[:remove_code_examples]
  result = remove_images(result) if options[:remove_images]
  result = remove_blockquotes(result) if options[:remove_blockquotes]

  result
end