Class: HtmlToMarkdown::ConversionOptions

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ConversionOptions

Returns a new instance of ConversionOptions.

Parameters:

  • heading_style: (enum_HeadingStyle)
  • list_indent_type: (enum_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: (enum_HighlightStyle)
  • extract_metadata: (Boolean)
  • whitespace_mode: (enum_WhitespaceMode)
  • strip_newlines: (Boolean)
  • wrap: (Boolean)
  • wrap_width: (Integer)
  • convert_as_inline: (Boolean)
  • sub_symbol: (String)
  • sup_symbol: (String)
  • newline_style: (enum_NewlineStyle)
  • code_block_style: (enum_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: (enum_UrlEscapeStyle)
  • link_style: (enum_LinkStyle)
  • output_format: (enum_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: (enum_TierStrategy)
  • base_url: (String)
  • visitor: (VisitorHandle) 


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

def initialize: (?heading_style: enum_HeadingStyle, ?list_indent_type: enum_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: enum_HighlightStyle, ?extract_metadata: bool, ?whitespace_mode: enum_WhitespaceMode, ?strip_newlines: bool, ?wrap: bool, ?wrap_width: Integer, ?convert_as_inline: bool, ?sub_symbol: String, ?sup_symbol: String, ?newline_style: enum_NewlineStyle, ?code_block_style: enum_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: enum_UrlEscapeStyle, ?link_style: enum_LinkStyle, ?output_format: enum_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: enum_TierStrategy, ?base_url: String, ?visitor: VisitorHandle) -> void

Instance Attribute Details

Returns the value of attribute autolinks.

Returns:

  • (Boolean) 


23
24
25
 
# File 'sig/types.rbs', line 23

def autolinks
  @autolinks
end

#base_url ⇒ String? (readonly)

Returns the value of attribute base_url.

Returns:

  • (String, nil) 


56
57
58
 
# File 'sig/types.rbs', line 56

def base_url
  @base_url
end

#br_in_tables ⇒ Boolean (readonly)

Returns the value of attribute br_in_tables.

Returns:

  • (Boolean) 


25
26
27
 
# File 'sig/types.rbs', line 25

def br_in_tables
  @br_in_tables
end

#bullets ⇒ String (readonly)

Returns the value of attribute bullets.

Returns:

  • (String) 


16
17
18
 
# File 'sig/types.rbs', line 16

def bullets
  @bullets
end

#capture_svg ⇒ Boolean (readonly)

Returns the value of attribute capture_svg.

Returns:

  • (Boolean) 


51
52
53
 
# File 'sig/types.rbs', line 51

def capture_svg
  @capture_svg
end

#code_block_style ⇒ enum_CodeBlockStyle (readonly)

Returns the value of attribute code_block_style.

Returns:

  • (enum_CodeBlockStyle) 


37
38
39
 
# File 'sig/types.rbs', line 37

def code_block_style
  @code_block_style
end

#code_language ⇒ String (readonly)

Returns the value of attribute code_language.

Returns:

  • (String) 


22
23
24
 
# File 'sig/types.rbs', line 22

def code_language
  @code_language
end

#compact_tables ⇒ Boolean (readonly)

Returns the value of attribute compact_tables.

Returns:

  • (Boolean) 


26
27
28
 
# File 'sig/types.rbs', line 26

def compact_tables
  @compact_tables
end

#convert_as_inline ⇒ Boolean (readonly)

Returns the value of attribute convert_as_inline.

Returns:

  • (Boolean) 


33
34
35
 
# File 'sig/types.rbs', line 33

def convert_as_inline
  @convert_as_inline
end

#debug ⇒ Boolean (readonly)

Returns the value of attribute debug.

Returns:

  • (Boolean) 


41
42
43
 
# File 'sig/types.rbs', line 41

def debug
  @debug
end

#default_title ⇒ Boolean (readonly)

Returns the value of attribute default_title.

Returns:

  • (Boolean) 


24
25
26
 
# File 'sig/types.rbs', line 24

def default_title
  @default_title
end

#encoding ⇒ String (readonly)

Returns the value of attribute encoding.

Returns:

  • (String) 


40
41
42
 
# File 'sig/types.rbs', line 40

def encoding
  @encoding
end

#escape_ascii ⇒ Boolean (readonly)

Returns the value of attribute escape_ascii.

Returns:

  • (Boolean) 


21
22
23
 
# File 'sig/types.rbs', line 21

def escape_ascii
  @escape_ascii
end

#escape_asterisks ⇒ Boolean (readonly)

Returns the value of attribute escape_asterisks.

Returns:

  • (Boolean) 


18
19
20
 
# File 'sig/types.rbs', line 18

def escape_asterisks
  @escape_asterisks
end

#escape_misc ⇒ Boolean (readonly)

Returns the value of attribute escape_misc.

Returns:

  • (Boolean) 


20
21
22
 
# File 'sig/types.rbs', line 20

def escape_misc
  @escape_misc
end

#escape_underscores ⇒ Boolean (readonly)

Returns the value of attribute escape_underscores.

Returns:

  • (Boolean) 


19
20
21
 
# File 'sig/types.rbs', line 19

def escape_underscores
  @escape_underscores
end

#exclude_selectors ⇒ Array[String] (readonly)

Returns the value of attribute exclude_selectors.

Returns:

  • (Array[String]) 


54
55
56
 
# File 'sig/types.rbs', line 54

def exclude_selectors
  @exclude_selectors
end

#extract_images ⇒ Boolean (readonly)

Returns the value of attribute extract_images.

Returns:

  • (Boolean) 


49
50
51
 
# File 'sig/types.rbs', line 49

def extract_images
  @extract_images
end

#extract_metadata ⇒ Boolean (readonly)

Returns the value of attribute extract_metadata.

Returns:

  • (Boolean) 


28
29
30
 
# File 'sig/types.rbs', line 28

def extract_metadata
  @extract_metadata
end

#heading_style ⇒ enum_HeadingStyle (readonly)

Returns the value of attribute heading_style.

Returns:

  • (enum_HeadingStyle) 


13
14
15
 
# File 'sig/types.rbs', line 13

def heading_style
  @heading_style
end

#highlight_style ⇒ enum_HighlightStyle (readonly)

Returns the value of attribute highlight_style.

Returns:

  • (enum_HighlightStyle) 


27
28
29
 
# File 'sig/types.rbs', line 27

def highlight_style
  @highlight_style
end

#include_document_structure ⇒ Boolean (readonly)

Returns the value of attribute include_document_structure.

Returns:

  • (Boolean) 


48
49
50
 
# File 'sig/types.rbs', line 48

def include_document_structure
  @include_document_structure
end

#infer_dimensions ⇒ Boolean (readonly)

Returns the value of attribute infer_dimensions.

Returns:

  • (Boolean) 


52
53
54
 
# File 'sig/types.rbs', line 52

def infer_dimensions
  @infer_dimensions
end

#keep_inline_images_in ⇒ Array[String] (readonly)

Returns the value of attribute keep_inline_images_in.

Returns:

  • (Array[String]) 


38
39
40
 
# File 'sig/types.rbs', line 38

def keep_inline_images_in
  @keep_inline_images_in
end

#link_style ⇒ enum_LinkStyle (readonly)

Returns the value of attribute link_style.

Returns:

  • (enum_LinkStyle) 


46
47
48
 
# File 'sig/types.rbs', line 46

def link_style
  @link_style
end

#list_indent_type ⇒ enum_ListIndentType (readonly)

Returns the value of attribute list_indent_type.

Returns:

  • (enum_ListIndentType) 


14
15
16
 
# File 'sig/types.rbs', line 14

def list_indent_type
  @list_indent_type
end

#list_indent_width ⇒ Integer (readonly)

Returns the value of attribute list_indent_width.

Returns:

  • (Integer) 


15
16
17
 
# File 'sig/types.rbs', line 15

def list_indent_width
  @list_indent_width
end

#max_depth ⇒ Integer? (readonly)

Returns the value of attribute max_depth.

Returns:

  • (Integer, nil) 


53
54
55
 
# File 'sig/types.rbs', line 53

def max_depth
  @max_depth
end

#max_image_size ⇒ Integer (readonly)

Returns the value of attribute max_image_size.

Returns:

  • (Integer) 


50
51
52
 
# File 'sig/types.rbs', line 50

def max_image_size
  @max_image_size
end

#newline_style ⇒ enum_NewlineStyle (readonly)

Returns the value of attribute newline_style.

Returns:

  • (enum_NewlineStyle) 


36
37
38
 
# File 'sig/types.rbs', line 36

def newline_style
  @newline_style
end

#output_format ⇒ enum_OutputFormat (readonly)

Returns the value of attribute output_format.

Returns:

  • (enum_OutputFormat) 


47
48
49
 
# File 'sig/types.rbs', line 47

def output_format
  @output_format
end

#preprocessing ⇒ PreprocessingOptions (readonly)

Returns the value of attribute preprocessing.

Returns:



39
40
41
 
# File 'sig/types.rbs', line 39

def preprocessing
  @preprocessing
end

#preserve_tags ⇒ Array[String] (readonly)

Returns the value of attribute preserve_tags.

Returns:

  • (Array[String]) 


43
44
45
 
# File 'sig/types.rbs', line 43

def preserve_tags
  @preserve_tags
end

#skip_images ⇒ Boolean (readonly)

Returns the value of attribute skip_images.

Returns:

  • (Boolean) 


44
45
46
 
# File 'sig/types.rbs', line 44

def skip_images
  @skip_images
end

#strip_newlines ⇒ Boolean (readonly)

Returns the value of attribute strip_newlines.

Returns:

  • (Boolean) 


30
31
32
 
# File 'sig/types.rbs', line 30

def strip_newlines
  @strip_newlines
end

#strip_tags ⇒ Array[String] (readonly)

Returns the value of attribute strip_tags.

Returns:

  • (Array[String]) 


42
43
44
 
# File 'sig/types.rbs', line 42

def strip_tags
  @strip_tags
end

#strong_em_symbol ⇒ String (readonly)

Returns the value of attribute strong_em_symbol.

Returns:

  • (String) 


17
18
19
 
# File 'sig/types.rbs', line 17

def strong_em_symbol
  @strong_em_symbol
end

#sub_symbol ⇒ String (readonly)

Returns the value of attribute sub_symbol.

Returns:

  • (String) 


34
35
36
 
# File 'sig/types.rbs', line 34

def sub_symbol
  @sub_symbol
end

#sup_symbol ⇒ String (readonly)

Returns the value of attribute sup_symbol.

Returns:

  • (String) 


35
36
37
 
# File 'sig/types.rbs', line 35

def sup_symbol
  @sup_symbol
end

#tier_strategy ⇒ enum_TierStrategy (readonly)

Returns the value of attribute tier_strategy.

Returns:

  • (enum_TierStrategy) 


55
56
57
 
# File 'sig/types.rbs', line 55

def tier_strategy
  @tier_strategy
end

#url_escape_style ⇒ enum_UrlEscapeStyle (readonly)

Returns the value of attribute url_escape_style.

Returns:

  • (enum_UrlEscapeStyle) 


45
46
47
 
# File 'sig/types.rbs', line 45

def url_escape_style
  @url_escape_style
end

#visitor ⇒ VisitorHandle? (readonly)

Returns the value of attribute visitor.

Returns:



57
58
59
 
# File 'sig/types.rbs', line 57

def visitor
  @visitor
end

#whitespace_mode ⇒ enum_WhitespaceMode (readonly)

Returns the value of attribute whitespace_mode.

Returns:

  • (enum_WhitespaceMode) 


29
30
31
 
# File 'sig/types.rbs', line 29

def whitespace_mode
  @whitespace_mode
end

#wrap ⇒ Boolean (readonly)

Returns the value of attribute wrap.

Returns:

  • (Boolean) 


31
32
33
 
# File 'sig/types.rbs', line 31

def wrap
  @wrap
end

#wrap_width ⇒ Integer (readonly)

Returns the value of attribute wrap_width.

Returns:

  • (Integer) 


32
33
34
 
# File 'sig/types.rbs', line 32

def wrap_width
  @wrap_width
end