Configuration for parsing and rendering RST documents
Constructors
new(unsafe : Bool = false, tab_width : Int32 = 8, max_nesting_depth : Int32 = 100)
SourceInstance methods
admonition_classes
Custom CSS classes for admonitions
Sourceadmonition_classes=(admonition_classes : Hash(String, String))
Custom CSS classes for admonitions
Sourceallowed_include_paths
Allowed paths for include directive (empty means allow all relative paths)
Sourceallowed_include_paths=(allowed_include_paths : Array(String))
Allowed paths for include directive (empty means allow all relative paths)
Sourceauthors=(authors : Array(String))
Sourcebase_path
Base directory for resolving relative paths (include directive, etc.)
Defaults to the current working directory at Config creation time.
Sourcebase_path=(base_path : String)
Base directory for resolving relative paths (include directive, etc.)
Defaults to the current working directory at Config creation time.
Sourcecustom_directives
Custom directive handlers
Proc takes: name, arguments, options, children, config -> Array(Node)
Sourcecustom_directives=(custom_directives : Hash(String, DirectiveHandler))
Custom directive handlers
Proc takes: name, arguments, options, children, config -> Array(Node)
Sourcedate=(date : String | Nil)
Sourceencoding
Output encoding (default: "utf-8")
Sourceencoding=(encoding : String)
Output encoding (default: "utf-8")
Sourcelanguage
Language for code blocks (default: nil, auto-detect)
Sourcelanguage=(language : String | Nil)
Language for code blocks (default: nil, auto-detect)
Sourcemax_nesting_depth
Maximum nesting depth to prevent stack overflow (default: 100)
Sourcemax_nesting_depth=(max_nesting_depth : Int32)
Maximum nesting depth to prevent stack overflow (default: 100)
Sourceroles=(roles : Hash(String, String))
Sourcetab_width
Tab width for indentation (default: 8)
Sourcetab_width=(tab_width : Int32)
Tab width for indentation (default: 8)
Sourcetitle=(title : String | Nil)
Sourceunsafe=(unsafe : Bool)
Allow unsafe content (HTML pass-through, raw directives, etc.)
Sourceunsafe?
Allow unsafe content (HTML pass-through, raw directives, etc.)
Source