Class: HtmlToMarkdown::ConversionOptions

Inherits:
Object
  • Object
show all
Defined in:
sig/types.rbs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ConversionOptions

Returns a new instance of ConversionOptions.

Parameters:

  • heading_style: (HeadingStyle)
  • list_indent_type: (ListIndentType)
  • list_indent_width: (Integer)
  • bullets: (String)
  • strong_em_symbol: (String)
  • escape_asterisks: (Boolean)
  • escape_underscores: (Boolean)
  • escape_misc: (Boolean)
  • escape_ascii: (Boolean)
  • code_language: (String)
  • autolinks: (Boolean)
  • default_title: (Boolean)
  • br_in_tables: (Boolean)
  • compact_tables: (Boolean)
  • highlight_style: (HighlightStyle)
  • extract_metadata: (Boolean)
  • whitespace_mode: (WhitespaceMode)
  • strip_newlines: (Boolean)
  • wrap: (Boolean)
  • wrap_width: (Integer)
  • convert_as_inline: (Boolean)
  • sub_symbol: (String)
  • sup_symbol: (String)
  • newline_style: (NewlineStyle)
  • code_block_style: (CodeBlockStyle)
  • keep_inline_images_in: (Array[String])
  • preprocessing: (PreprocessingOptions)
  • encoding: (String)
  • debug: (Boolean)
  • strip_tags: (Array[String])
  • preserve_tags: (Array[String])
  • skip_images: (Boolean)
  • url_escape_style: (UrlEscapeStyle)
  • link_style: (LinkStyle)
  • output_format: (OutputFormat)
  • include_document_structure: (Boolean)
  • extract_images: (Boolean)
  • max_image_size: (Integer)
  • capture_svg: (Boolean)
  • infer_dimensions: (Boolean)
  • max_depth: (Integer)
  • exclude_selectors: (Array[String])
  • tier_strategy: (TierStrategy)
  • visitor: (VisitorHandle) 


125
 
# File 'sig/types.rbs', line 125

def initialize: (?heading_style: HeadingStyle, ?list_indent_type: ListIndentType, ?list_indent_width: Integer, ?bullets: String, ?strong_em_symbol: String, ?escape_asterisks: bool, ?escape_underscores: bool, ?escape_misc: bool, ?escape_ascii: bool, ?code_language: String, ?autolinks: bool, ?default_title: bool, ?br_in_tables: bool, ?compact_tables: bool, ?highlight_style: HighlightStyle, ?extract_metadata: bool, ?whitespace_mode: WhitespaceMode, ?strip_newlines: bool, ?wrap: bool, ?wrap_width: Integer, ?convert_as_inline: bool, ?sub_symbol: String, ?sup_symbol: String, ?newline_style: NewlineStyle, ?code_block_style: CodeBlockStyle, ?keep_inline_images_in: Array[String], ?preprocessing: PreprocessingOptions, ?encoding: String, ?debug: bool, ?strip_tags: Array[String], ?preserve_tags: Array[String], ?skip_images: bool, ?url_escape_style: UrlEscapeStyle, ?link_style: LinkStyle, ?output_format: OutputFormat, ?include_document_structure: bool, ?extract_images: bool, ?max_image_size: Integer, ?capture_svg: bool, ?infer_dimensions: bool, ?max_depth: Integer, ?exclude_selectors: Array[String], ?tier_strategy: TierStrategy, ?visitor: VisitorHandle) -> void

Instance Attribute Details

Returns the value of attribute autolinks.

Returns:

  • (Boolean, nil) 


90
91
92
 
# File 'sig/types.rbs', line 90

def autolinks
  @autolinks
end

#br_in_tables ⇒ Boolean?

Returns the value of attribute br_in_tables.

Returns:

  • (Boolean, nil) 


92
93
94
 
# File 'sig/types.rbs', line 92

def br_in_tables
  @br_in_tables
end

#bullets ⇒ String?

Returns the value of attribute bullets.

Returns:

  • (String, nil) 


83
84
85
 
# File 'sig/types.rbs', line 83

def bullets
  @bullets
end

#capture_svg ⇒ Boolean?

Returns the value of attribute capture_svg.

Returns:

  • (Boolean, nil) 


118
119
120
 
# File 'sig/types.rbs', line 118

def capture_svg
  @capture_svg
end

#code_block_style ⇒ CodeBlockStyle?

Returns the value of attribute code_block_style.

Returns:



104
105
106
 
# File 'sig/types.rbs', line 104

def code_block_style
  @code_block_style
end

#code_language ⇒ String?

Returns the value of attribute code_language.

Returns:

  • (String, nil) 


89
90
91
 
# File 'sig/types.rbs', line 89

def code_language
  @code_language
end

#compact_tables ⇒ Boolean?

Returns the value of attribute compact_tables.

Returns:

  • (Boolean, nil) 


93
94
95
 
# File 'sig/types.rbs', line 93

def compact_tables
  @compact_tables
end

#convert_as_inline ⇒ Boolean?

Returns the value of attribute convert_as_inline.

Returns:

  • (Boolean, nil) 


100
101
102
 
# File 'sig/types.rbs', line 100

def convert_as_inline
  @convert_as_inline
end

#debug ⇒ Boolean?

Returns the value of attribute debug.

Returns:

  • (Boolean, nil) 


108
109
110
 
# File 'sig/types.rbs', line 108

def debug
  @debug
end

#default_title ⇒ Boolean?

Returns the value of attribute default_title.

Returns:

  • (Boolean, nil) 


91
92
93
 
# File 'sig/types.rbs', line 91

def default_title
  @default_title
end

#encoding ⇒ String?

Returns the value of attribute encoding.

Returns:

  • (String, nil) 


107
108
109
 
# File 'sig/types.rbs', line 107

def encoding
  @encoding
end

#escape_ascii ⇒ Boolean?

Returns the value of attribute escape_ascii.

Returns:

  • (Boolean, nil) 


88
89
90
 
# File 'sig/types.rbs', line 88

def escape_ascii
  @escape_ascii
end

#escape_asterisks ⇒ Boolean?

Returns the value of attribute escape_asterisks.

Returns:

  • (Boolean, nil) 


85
86
87
 
# File 'sig/types.rbs', line 85

def escape_asterisks
  @escape_asterisks
end

#escape_misc ⇒ Boolean?

Returns the value of attribute escape_misc.

Returns:

  • (Boolean, nil) 


87
88
89
 
# File 'sig/types.rbs', line 87

def escape_misc
  @escape_misc
end

#escape_underscores ⇒ Boolean?

Returns the value of attribute escape_underscores.

Returns:

  • (Boolean, nil) 


86
87
88
 
# File 'sig/types.rbs', line 86

def escape_underscores
  @escape_underscores
end

#exclude_selectors ⇒ Array[String]?

Returns the value of attribute exclude_selectors.

Returns:

  • (Array[String], nil) 


121
122
123
 
# File 'sig/types.rbs', line 121

def exclude_selectors
  @exclude_selectors
end

#extract_images ⇒ Boolean?

Returns the value of attribute extract_images.

Returns:

  • (Boolean, nil) 


116
117
118
 
# File 'sig/types.rbs', line 116

def extract_images
  @extract_images
end

#extract_metadata ⇒ Boolean?

Returns the value of attribute extract_metadata.

Returns:

  • (Boolean, nil) 


95
96
97
 
# File 'sig/types.rbs', line 95

def extract_metadata
  @extract_metadata
end

#heading_style ⇒ HeadingStyle?

Returns the value of attribute heading_style.

Returns:



80
81
82
 
# File 'sig/types.rbs', line 80

def heading_style
  @heading_style
end

#highlight_style ⇒ HighlightStyle?

Returns the value of attribute highlight_style.

Returns:



94
95
96
 
# File 'sig/types.rbs', line 94

def highlight_style
  @highlight_style
end

#include_document_structure ⇒ Boolean?

Returns the value of attribute include_document_structure.

Returns:

  • (Boolean, nil) 


115
116
117
 
# File 'sig/types.rbs', line 115

def include_document_structure
  @include_document_structure
end

#infer_dimensions ⇒ Boolean?

Returns the value of attribute infer_dimensions.

Returns:

  • (Boolean, nil) 


119
120
121
 
# File 'sig/types.rbs', line 119

def infer_dimensions
  @infer_dimensions
end

#keep_inline_images_in ⇒ Array[String]?

Returns the value of attribute keep_inline_images_in.

Returns:

  • (Array[String], nil) 


105
106
107
 
# File 'sig/types.rbs', line 105

def keep_inline_images_in
  @keep_inline_images_in
end

#link_style ⇒ LinkStyle?

Returns the value of attribute link_style.

Returns:



113
114
115
 
# File 'sig/types.rbs', line 113

def link_style
  @link_style
end

#list_indent_type ⇒ ListIndentType?

Returns the value of attribute list_indent_type.

Returns:



81
82
83
 
# File 'sig/types.rbs', line 81

def list_indent_type
  @list_indent_type
end

#list_indent_width ⇒ Integer?

Returns the value of attribute list_indent_width.

Returns:

  • (Integer, nil) 


82
83
84
 
# File 'sig/types.rbs', line 82

def list_indent_width
  @list_indent_width
end

#max_depth ⇒ Integer?

Returns the value of attribute max_depth.

Returns:

  • (Integer, nil) 


120
121
122
 
# File 'sig/types.rbs', line 120

def max_depth
  @max_depth
end

#max_image_size ⇒ Integer?

Returns the value of attribute max_image_size.

Returns:

  • (Integer, nil) 


117
118
119
 
# File 'sig/types.rbs', line 117

def max_image_size
  @max_image_size
end

#newline_style ⇒ NewlineStyle?

Returns the value of attribute newline_style.

Returns:



103
104
105
 
# File 'sig/types.rbs', line 103

def newline_style
  @newline_style
end

#output_format ⇒ OutputFormat?

Returns the value of attribute output_format.

Returns:



114
115
116
 
# File 'sig/types.rbs', line 114

def output_format
  @output_format
end

#preprocessing ⇒ PreprocessingOptions?

Returns the value of attribute preprocessing.

Returns:



106
107
108
 
# File 'sig/types.rbs', line 106

def preprocessing
  @preprocessing
end

#preserve_tags ⇒ Array[String]?

Returns the value of attribute preserve_tags.

Returns:

  • (Array[String], nil) 


110
111
112
 
# File 'sig/types.rbs', line 110

def preserve_tags
  @preserve_tags
end

#skip_images ⇒ Boolean?

Returns the value of attribute skip_images.

Returns:

  • (Boolean, nil) 


111
112
113
 
# File 'sig/types.rbs', line 111

def skip_images
  @skip_images
end

#strip_newlines ⇒ Boolean?

Returns the value of attribute strip_newlines.

Returns:

  • (Boolean, nil) 


97
98
99
 
# File 'sig/types.rbs', line 97

def strip_newlines
  @strip_newlines
end

#strip_tags ⇒ Array[String]?

Returns the value of attribute strip_tags.

Returns:

  • (Array[String], nil) 


109
110
111
 
# File 'sig/types.rbs', line 109

def strip_tags
  @strip_tags
end

#strong_em_symbol ⇒ String?

Returns the value of attribute strong_em_symbol.

Returns:

  • (String, nil) 


84
85
86
 
# File 'sig/types.rbs', line 84

def strong_em_symbol
  @strong_em_symbol
end

#sub_symbol ⇒ String?

Returns the value of attribute sub_symbol.

Returns:

  • (String, nil) 


101
102
103
 
# File 'sig/types.rbs', line 101

def sub_symbol
  @sub_symbol
end

#sup_symbol ⇒ String?

Returns the value of attribute sup_symbol.

Returns:

  • (String, nil) 


102
103
104
 
# File 'sig/types.rbs', line 102

def sup_symbol
  @sup_symbol
end

#tier_strategy ⇒ TierStrategy?

Returns the value of attribute tier_strategy.

Returns:



122
123
124
 
# File 'sig/types.rbs', line 122

def tier_strategy
  @tier_strategy
end

#url_escape_style ⇒ UrlEscapeStyle?

Returns the value of attribute url_escape_style.

Returns:



112
113
114
 
# File 'sig/types.rbs', line 112

def url_escape_style
  @url_escape_style
end

#visitor ⇒ VisitorHandle?

Returns the value of attribute visitor.

Returns:



123
124
125
 
# File 'sig/types.rbs', line 123

def visitor
  @visitor
end

#whitespace_mode ⇒ WhitespaceMode?

Returns the value of attribute whitespace_mode.

Returns:



96
97
98
 
# File 'sig/types.rbs', line 96

def whitespace_mode
  @whitespace_mode
end

#wrap ⇒ Boolean?

Returns the value of attribute wrap.

Returns:

  • (Boolean, nil) 


98
99
100
 
# File 'sig/types.rbs', line 98

def wrap
  @wrap
end

#wrap_width ⇒ Integer?

Returns the value of attribute wrap_width.

Returns:

  • (Integer, nil) 


99
100
101
 
# File 'sig/types.rbs', line 99

def wrap_width
  @wrap_width
end

Class Method Details

.default ⇒ ConversionOptions

Returns:



126
 
# File 'sig/types.rbs', line 126

def self.default: () -> ConversionOptions