class Crst::Config

• Crst::Config
• Reference
• Object

Overview

Configuration for parsing and rendering RST documents

Defined in:

crst/config.cr

Constructors

• .new(unsafe : Bool = false)

Instance Method Summary

• #admonition_classes : Hash(String, String)

  Custom CSS classes for admonitions

• #admonition_classes=(admonition_classes : Hash(String, String))

  Custom CSS classes for admonitions

• #allowed_include_paths : Array(String)

  Allowed paths for include directive (empty means allow all relative paths)

• #allowed_include_paths=(allowed_include_paths : Array(String))

  Allowed paths for include directive (empty means allow all relative paths)

• #authors : Array(String)
• #authors=(authors : Array(String))
• #custom_directives : Hash(String, DirectiveHandler)

  Custom directive handlers Proc takes: name, arguments, options, children, config -> Array(Node)

• #custom_directives=(custom_directives : Hash(String, DirectiveHandler))

  Custom directive handlers Proc takes: name, arguments, options, children, config -> Array(Node)

• #date : String | Nil
• #date=(date : String | Nil)
• #encoding : String

  Output encoding (default: "utf-8")

• #encoding=(encoding : String)

  Output encoding (default: "utf-8")

• #language : String | Nil

  Language for code blocks (default: nil, auto-detect)

• #language=(language : String | Nil)

  Language for code blocks (default: nil, auto-detect)

• #meta : Hash(String, String)
• #meta=(meta : Hash(String, String))
• #roles : Hash(String, String)

  Custom role definitions

• #roles=(roles : Hash(String, String))

  Custom role definitions

• #substitutions : Hash(String, Array(Crst::Node))

  Substitution definitions

• #substitutions=(substitutions : Hash(String, Array(Crst::Node)))

  Substitution definitions

• #tab_width : Int32

  Tab width for indentation (default: 8)

• #tab_width=(tab_width : Int32)

  Tab width for indentation (default: 8)

• #title : String | Nil

  Document metadata

• #title=(title : String | Nil)

  Document metadata

• #unsafe=(unsafe : Bool)

  Allow unsafe content (HTML pass-through, raw directives, etc.)

• #unsafe? : Bool

  Allow unsafe content (HTML pass-through, raw directives, etc.)

Constructor Detail

Instance Method Detail