# Table of Contents - RDoc Documentation

## Pages

- README
  - kramdown
  - Readme first!
  - Introduction
  - Usage
  - Development
  - License

## Classes and Modules

- Kramdown
- Kramdown::Converter
- Kramdown::Converter::Base
  - Base class for converters
  - Implementing a converter
- Kramdown::Converter::HashAST
- Kramdown::Converter::HashAst
- Kramdown::Converter::Html
- Kramdown::Converter::Kramdown
- Kramdown::Converter::Latex
- Kramdown::Converter::Man
- Kramdown::Converter::MathEngine
- Kramdown::Converter::MathEngine::Itex2MML
- Kramdown::Converter::MathEngine::Katex
- Kramdown::Converter::MathEngine::Mathjax
- Kramdown::Converter::MathEngine::MathjaxNode
- Kramdown::Converter::MathEngine::Ritex
- Kramdown::Converter::MathEngine::SsKaTeX
- Kramdown::Converter::Pdf
  - Top Section
  - Element rendering methods
  - Helper methods
  - Organizational methods
- Kramdown::Converter::Pdf::PrawnDocumentExtension
- Kramdown::Converter::Pdf::PrawnDocumentExtension::CustomBox
- Kramdown::Converter::RemoveHtmlTags
- Kramdown::Converter::SyntaxHighlighter
  - Container for Syntax Highlighters
  - Implementing a Syntax Highlighter
  - Special Implementation Details
- Kramdown::Converter::SyntaxHighlighter::Coderay
- Kramdown::Converter::SyntaxHighlighter::Minted
- Kramdown::Converter::SyntaxHighlighter::Rouge
- Kramdown::Converter::Toc
- Kramdown::Document
- Kramdown::Element
  - Structural Elements
  - :root
  - :blank
  - :p
  - :header
  - :blockquote
  - :codeblock
  - :ul
  - :ol
  - :li
  - :dl
  - :dt
  - :dd
  - :hr
  - :table
  - :thead
  - :tbody
  - :tfoot
  - :tr
  - :td
  - :math
  - Text Markup Elements
  - :text
  - :br
  - :a
  - :img
  - :codespan
  - :footnote
  - :em
  - :strong
  - :entity
  - :typographic_sym
  - :smart_quote
  - :abbreviation
  - Other Elements
  - :html_element
  - :xml_comment
  - :xml_pi
  - :comment
  - :raw
- Kramdown::Error
- Kramdown::Options
  - Option Validators
  - Option definitions
- Kramdown::Options::Boolean
- Kramdown::Parser
- Kramdown::Parser::Base
  - Base class for parsers
  - Implementing a parser
- Kramdown::Parser::GFM
- Kramdown::Parser::Html
- Kramdown::Parser::Html::Constants
- Kramdown::Parser::Html::ElementConverter
- Kramdown::Parser::Html::Parser
- Kramdown::Parser::Kramdown
- Kramdown::Parser::Markdown
- Kramdown::Utils
  - Utils Module
- Kramdown::Utils::Configurable
- Kramdown::Utils::Entities
- Kramdown::Utils::Entities::Entity
- Kramdown::Utils::Html
- Kramdown::Utils::LRUCache
- Kramdown::Utils::StringScanner
- Kramdown::Utils::Unidecoder

## Methods

- ::=== — Kramdown::Options::Boolean
- ::call — Kramdown::Converter::MathEngine::Itex2MML
- ::call — Kramdown::Converter::MathEngine::Katex
- ::call — Kramdown::Converter::MathEngine::Mathjax
- ::call — Kramdown::Converter::MathEngine::MathjaxNode
- ::call — Kramdown::Converter::MathEngine::Ritex
- ::call — Kramdown::Converter::MathEngine::SsKaTeX
- ::call — Kramdown::Converter::SyntaxHighlighter::Coderay
- ::call — Kramdown::Converter::SyntaxHighlighter::Minted
- ::call — Kramdown::Converter::SyntaxHighlighter::Rouge
- ::camelize — Kramdown::Utils
- ::category — Kramdown::Element
- ::convert — Kramdown::Converter::Base
- ::data_dir — Kramdown
- ::decode — Kramdown::Utils::Unidecoder
- ::deep_const_get — Kramdown::Utils
- ::defaults — Kramdown::Options
- ::define — Kramdown::Options
- ::define_parser — Kramdown::Parser::Kramdown
- ::defined? — Kramdown::Options
- ::definitions — Kramdown::Options
- ::entity — Kramdown::Utils::Entities
- ::formatter_class — Kramdown::Converter::SyntaxHighlighter::Rouge
- ::get_template — Kramdown::Converter::Base
- ::has_parser? — Kramdown::Parser::Kramdown
- ::katex_conv — Kramdown::Converter::MathEngine::SsKaTeX
- ::logger — Kramdown::Converter::MathEngine::SsKaTeX
- ::merge — Kramdown::Options
- ::new — Kramdown::Converter::Base
- ::new — Kramdown::Converter::Html
- ::new — Kramdown::Converter::Latex
- ::new — Kramdown::Converter::Pdf
- ::new — Kramdown::Converter::RemoveHtmlTags
- ::new — Kramdown::Converter::Toc
- ::new — Kramdown::Document
- ::new — Kramdown::Element
- ::new — Kramdown::Parser::Base
- ::new — Kramdown::Parser::GFM
- ::new — Kramdown::Parser::Kramdown
- ::new — Kramdown::Parser::Kramdown
- ::new — Kramdown::Utils::LRUCache
- ::new — Kramdown::Utils::StringScanner
- ::options — Kramdown::Converter::SyntaxHighlighter::Coderay
- ::options — Kramdown::Converter::SyntaxHighlighter::Rouge
- ::parse — Kramdown::Parser::Base
- ::parse — Kramdown::Options
- ::parser — Kramdown::Parser::Kramdown
- ::prepare_options — Kramdown::Converter::SyntaxHighlighter::Coderay
- ::prepare_options — Kramdown::Converter::SyntaxHighlighter::Rouge
- ::preview_string — Kramdown::Converter::MathEngine::Mathjax
- ::simple_array_validator — Kramdown::Options
- ::simple_hash_validator — Kramdown::Options
- ::snake_case — Kramdown::Utils
- ::str_to_sym — Kramdown::Options
- #[] — Kramdown::Utils::LRUCache
- #[]= — Kramdown::Utils::LRUCache
- #a_options — Kramdown::Converter::Pdf
- #abbreviation_options — Kramdown::Converter::Pdf
- #adapt_source — Kramdown::Parser::Base
- #add_header — Kramdown::Parser::Kramdown
- #add_link — Kramdown::Parser::Kramdown
- #add_syntax_highlighter_to_class_attr — Kramdown::Converter::Html
- #add_text — Kramdown::Parser::Base
- #add_to_toc — Kramdown::Converter::Toc
- #after_block_boundary? — Kramdown::Parser::Kramdown
- #apply_template_after? — Kramdown::Converter::Base
- #apply_template_after? — Kramdown::Converter::Pdf
- #apply_template_before? — Kramdown::Converter::Base
- #apply_template_before? — Kramdown::Converter::Pdf
- #attr — Kramdown::Element
- #attribute_list — Kramdown::Converter::Latex
- #available_width — Kramdown::Converter::Pdf::PrawnDocumentExtension::CustomBox
- #basic_generate_id — Kramdown::Converter::Base
- #before_block_boundary? — Kramdown::Parser::Kramdown
- #block_hash — Kramdown::Converter::Pdf
- #blockquote_options — Kramdown::Converter::Pdf
- #br_options — Kramdown::Converter::Pdf
- #char — Kramdown::Utils::Entities::Entity
- #codeblock_options — Kramdown::Converter::Pdf
- #codespan_options — Kramdown::Converter::Pdf
- #configurable — Kramdown::Utils::Configurable
- #configure_parser — Kramdown::Parser::Kramdown
- #convert — Kramdown::Converter::Base
- #convert — Kramdown::Converter::HashAST
- #convert — Kramdown::Converter::HashAST
- #convert — Kramdown::Converter::Html
- #convert — Kramdown::Converter::Latex
- #convert — Kramdown::Converter::Pdf
- #convert — Kramdown::Converter::RemoveHtmlTags
- #convert — Kramdown::Converter::Toc
- #convert_a — Kramdown::Converter::Html
- #convert_a — Kramdown::Converter::Latex
- #convert_a — Kramdown::Converter::Man
- #convert_abbreviation — Kramdown::Converter::Html
- #convert_abbreviation — Kramdown::Converter::Latex
- #convert_abbreviation — Kramdown::Converter::Man
- #convert_blank — Kramdown::Converter::Html
- #convert_blank — Kramdown::Converter::Latex
- #convert_blank — Kramdown::Converter::Man
- #convert_blockquote — Kramdown::Converter::Html
- #convert_blockquote — Kramdown::Converter::Latex
- #convert_blockquote — Kramdown::Converter::Man
- #convert_br — Kramdown::Converter::Html
- #convert_br — Kramdown::Converter::Latex
- #convert_br — Kramdown::Converter::Man
- #convert_codeblock — Kramdown::Converter::Html
- #convert_codeblock — Kramdown::Converter::Latex
- #convert_codeblock — Kramdown::Converter::Man
- #convert_codespan — Kramdown::Converter::Html
- #convert_codespan — Kramdown::Converter::Latex
- #convert_codespan — Kramdown::Converter::Man
- #convert_comment — Kramdown::Converter::Html
- #convert_comment — Kramdown::Converter::Latex
- #convert_comment — Kramdown::Converter::Man
- #convert_dd — Kramdown::Converter::Html
- #convert_dd — Kramdown::Converter::Latex
- #convert_dd — Kramdown::Converter::Man
- #convert_dl — Kramdown::Converter::Html
- #convert_dl — Kramdown::Converter::Latex
- #convert_dl — Kramdown::Converter::Man
- #convert_dt — Kramdown::Converter::Html
- #convert_dt — Kramdown::Converter::Latex
- #convert_dt — Kramdown::Converter::Man
- #convert_em — Kramdown::Converter::Html
- #convert_em — Kramdown::Converter::Latex
- #convert_em — Kramdown::Converter::Man
- #convert_entity — Kramdown::Converter::Html
- #convert_entity — Kramdown::Converter::Latex
- #convert_entity — Kramdown::Converter::Man
- #convert_footnote — Kramdown::Converter::Html
- #convert_footnote — Kramdown::Converter::Latex
- #convert_footnote — Kramdown::Converter::Man
- #convert_header — Kramdown::Converter::Html
- #convert_header — Kramdown::Converter::Latex
- #convert_header — Kramdown::Converter::Man
- #convert_hr — Kramdown::Converter::Html
- #convert_hr — Kramdown::Converter::Latex
- #convert_hr — Kramdown::Converter::Man
- #convert_html_element — Kramdown::Converter::Html
- #convert_html_element — Kramdown::Converter::Latex
- #convert_html_element — Kramdown::Converter::Man
- #convert_img — Kramdown::Converter::Html
- #convert_img — Kramdown::Converter::Latex
- #convert_img — Kramdown::Converter::Man
- #convert_li — Kramdown::Converter::Html
- #convert_li — Kramdown::Converter::Latex
- #convert_li — Kramdown::Converter::Man
- #convert_math — Kramdown::Converter::Html
- #convert_math — Kramdown::Converter::Latex
- #convert_math — Kramdown::Converter::Man
- #convert_ol — Kramdown::Converter::Html
- #convert_ol — Kramdown::Converter::Latex
- #convert_ol — Kramdown::Converter::Man
- #convert_p — Kramdown::Converter::Html
- #convert_p — Kramdown::Converter::Latex
- #convert_p — Kramdown::Converter::Man
- #convert_raw — Kramdown::Converter::Html
- #convert_raw — Kramdown::Converter::Latex
- #convert_raw — Kramdown::Converter::Man
- #convert_root — Kramdown::Converter::Html
- #convert_root — Kramdown::Converter::Latex
- #convert_root — Kramdown::Converter::Man
- #convert_smart_quote — Kramdown::Converter::Html
- #convert_smart_quote — Kramdown::Converter::Latex
- #convert_smart_quote — Kramdown::Converter::Man
- #convert_standalone_image — Kramdown::Converter::Latex
- #convert_strong — Kramdown::Converter::Html
- #convert_strong — Kramdown::Converter::Latex
- #convert_strong — Kramdown::Converter::Man
- #convert_table — Kramdown::Converter::Html
- #convert_table — Kramdown::Converter::Latex
- #convert_table — Kramdown::Converter::Man
- #convert_tbody — Kramdown::Converter::Html
- #convert_tbody — Kramdown::Converter::Latex
- #convert_tbody — Kramdown::Converter::Man
- #convert_td — Kramdown::Converter::Html
- #convert_td — Kramdown::Converter::Latex
- #convert_td — Kramdown::Converter::Man
- #convert_text — Kramdown::Converter::Html
- #convert_text — Kramdown::Converter::Latex
- #convert_text — Kramdown::Converter::Man
- #convert_tfoot — Kramdown::Converter::Html
- #convert_tfoot — Kramdown::Converter::Latex
- #convert_tfoot — Kramdown::Converter::Man
- #convert_thead — Kramdown::Converter::Html
- #convert_thead — Kramdown::Converter::Latex
- #convert_thead — Kramdown::Converter::Man
- #convert_tr — Kramdown::Converter::Html
- #convert_tr — Kramdown::Converter::Latex
- #convert_tr — Kramdown::Converter::Man
- #convert_typographic_sym — Kramdown::Converter::Html
- #convert_typographic_sym — Kramdown::Converter::Latex
- #convert_typographic_sym — Kramdown::Converter::Man
- #convert_ul — Kramdown::Converter::Html
- #convert_ul — Kramdown::Converter::Latex
- #convert_ul — Kramdown::Converter::Man
- #convert_xml_comment — Kramdown::Converter::Html
- #convert_xml_comment — Kramdown::Converter::Latex
- #convert_xml_comment — Kramdown::Converter::Man
- #convert_xml_pi — Kramdown::Converter::Html
- #convert_xml_pi — Kramdown::Converter::Latex
- #convert_xml_pi — Kramdown::Converter::Man
- #correct_abbreviations_attributes — Kramdown::Parser::Kramdown
- #create_outline — Kramdown::Converter::Pdf
- #current_line_number — Kramdown::Utils::StringScanner
- #dd_options — Kramdown::Converter::Pdf
- #dl_options — Kramdown::Converter::Pdf
- #document_options — Kramdown::Converter::Pdf
- #dt_options — Kramdown::Converter::Pdf
- #em_options — Kramdown::Converter::Pdf
- #embed_image — Kramdown::Converter::Pdf::PrawnDocumentExtension
- #entity — Kramdown::Utils::Entities
- #entity_options — Kramdown::Converter::Pdf
- #entity_to_latex — Kramdown::Converter::Latex
- #entity_to_str — Kramdown::Utils::Html
- #escape — Kramdown::Converter::Latex
- #escape — Kramdown::Converter::Man
- #escape_html — Kramdown::Utils::Html
- #extract_code_language — Kramdown::Converter::Base
- #extract_code_language! — Kramdown::Converter::Base
- #extract_string — Kramdown::Parser::Base
- #finish_document — Kramdown::Converter::Pdf
- #fix_for_toc_entry — Kramdown::Converter::Html
- #footnote_content — Kramdown::Converter::Html
- #format_as_block_html — Kramdown::Converter::Html
- #format_as_indented_block_html — Kramdown::Converter::Html
- #format_as_span_html — Kramdown::Converter::Html
- #format_math — Kramdown::Converter::Base
- #generate_gfm_header_id — Kramdown::Parser::GFM
- #generate_id — Kramdown::Converter::Base
- #generate_toc_tree — Kramdown::Converter::Html
- #handle_extension — Kramdown::Parser::Kramdown
- #handle_html_start_tag — Kramdown::Parser::Html::Parser
- #handle_kramdown_html_tag — Kramdown::Parser::Kramdown
- #handle_raw_html_tag — Kramdown::Parser::Html::Parser
- #header_options — Kramdown::Converter::Pdf
- #highlight_code — Kramdown::Converter::Base
- #hr_options — Kramdown::Converter::Pdf
- #html_attributes — Kramdown::Utils::Html
- #image_floats — Kramdown::Converter::Pdf::PrawnDocumentExtension
- #img_options — Kramdown::Converter::Pdf
- #in_toc? — Kramdown::Converter::Base
- #inner — Kramdown::Converter::Html
- #inner — Kramdown::Converter::Latex
- #inner — Kramdown::Converter::Man
- #inner — Kramdown::Converter::Pdf
- #latex_environment — Kramdown::Converter::Latex
- #latex_link_target — Kramdown::Converter::Latex
- #li_options — Kramdown::Converter::Pdf
- #macro — Kramdown::Converter::Man
- #math_options — Kramdown::Converter::Pdf
- #method_missing — Kramdown::Document
- #new_block_el — Kramdown::Parser::Kramdown
- #newline — Kramdown::Converter::Man
- #normalize_abbreviation_key — Kramdown::Converter::Latex
- #normalize_link_id — Kramdown::Parser::Kramdown
- #obfuscate — Kramdown::Converter::Html
- #ol_options — Kramdown::Converter::Pdf
- #options — Kramdown::Element
- #output_header_level — Kramdown::Converter::Base
- #p_options — Kramdown::Converter::Pdf
- #paragraph_end — Kramdown::Parser::GFM
- #paragraph_end — Kramdown::Parser::Kramdown
- #parse — Kramdown::Parser::Base
- #parse — Kramdown::Parser::GFM
- #parse — Kramdown::Parser::Html
- #parse — Kramdown::Parser::Kramdown
- #parse_abbrev_definition — Kramdown::Parser::Kramdown
- #parse_attribute_list — Kramdown::Parser::Kramdown
- #parse_atx_header — Kramdown::Parser::Kramdown
- #parse_atx_header_gfm_quirk — Kramdown::Parser::GFM
- #parse_autolink — Kramdown::Parser::Kramdown
- #parse_blank_line — Kramdown::Parser::Kramdown
- #parse_block_extensions — Kramdown::Parser::Kramdown
- #parse_block_html — Kramdown::Parser::Kramdown
- #parse_block_math — Kramdown::Parser::Kramdown
- #parse_blockquote — Kramdown::Parser::Kramdown
- #parse_blocks — Kramdown::Parser::Kramdown
- #parse_codeblock — Kramdown::Parser::Kramdown
- #parse_codeblock_fenced — Kramdown::Parser::Kramdown
- #parse_codespan — Kramdown::Parser::Kramdown
- #parse_definition_list — Kramdown::Parser::Kramdown
- #parse_emphasis — Kramdown::Parser::Kramdown
- #parse_eob_marker — Kramdown::Parser::Kramdown
- #parse_escaped_chars — Kramdown::Parser::Kramdown
- #parse_extension_start_tag — Kramdown::Parser::Kramdown
- #parse_first_list_line — Kramdown::Parser::Kramdown
- #parse_footnote_definition — Kramdown::Parser::Kramdown
- #parse_footnote_marker — Kramdown::Parser::Kramdown
- #parse_header_contents — Kramdown::Parser::Kramdown
- #parse_horizontal_rule — Kramdown::Parser::Kramdown
- #parse_html_attributes — Kramdown::Parser::Html::Parser
- #parse_html_entity — Kramdown::Parser::Kramdown
- #parse_inline_math — Kramdown::Parser::Kramdown
- #parse_line_break — Kramdown::Parser::Kramdown
- #parse_link — Kramdown::Parser::Kramdown
- #parse_link_definition — Kramdown::Parser::Kramdown
- #parse_list — Kramdown::Parser::GFM
- #parse_list — Kramdown::Parser::Kramdown
- #parse_paragraph — Kramdown::Parser::Kramdown
- #parse_raw_html — Kramdown::Parser::Html::Parser
- #parse_setext_header — Kramdown::Parser::Kramdown
- #parse_smart_quotes — Kramdown::Parser::Kramdown
- #parse_span_extensions — Kramdown::Parser::Kramdown
- #parse_span_html — Kramdown::Parser::Kramdown
- #parse_spans — Kramdown::Parser::Kramdown
- #parse_strikethrough_gfm — Kramdown::Parser::GFM
- #parse_table — Kramdown::Parser::Kramdown
- #parse_typographic_syms — Kramdown::Parser::Kramdown
- #pos= — Kramdown::Utils::StringScanner
- #quote — Kramdown::Converter::Man
- #remove_footnotes — Kramdown::Converter::Html
- #render_a — Kramdown::Converter::Pdf
- #render_abbreviation — Kramdown::Converter::Pdf
- #render_blockquote — Kramdown::Converter::Pdf
- #render_br — Kramdown::Converter::Pdf
- #render_codeblock — Kramdown::Converter::Pdf
- #render_codespan — Kramdown::Converter::Pdf
- #render_dd — Kramdown::Converter::Pdf
- #render_dl — Kramdown::Converter::Pdf
- #render_dt — Kramdown::Converter::Pdf
- #render_em — Kramdown::Converter::Pdf
- #render_entity — Kramdown::Converter::Pdf
- #render_header — Kramdown::Converter::Pdf
- #render_hr — Kramdown::Converter::Pdf
- #render_li — Kramdown::Converter::Pdf
- #render_math — Kramdown::Converter::Pdf
- #render_ol — Kramdown::Converter::Pdf
- #render_p — Kramdown::Converter::Pdf
- #render_padded_and_formatted_text — Kramdown::Converter::Pdf
- #render_root — Kramdown::Converter::Pdf
- #render_smart_quote — Kramdown::Converter::Pdf
- #render_standalone_image — Kramdown::Converter::Pdf
- #render_strong — Kramdown::Converter::Pdf
- #render_table — Kramdown::Converter::Pdf
- #render_text — Kramdown::Converter::Pdf
- #render_typographic_sym — Kramdown::Converter::Pdf
- #render_ul — Kramdown::Converter::Pdf
- #replace_abbreviations — Kramdown::Parser::Kramdown
- #reset_env — Kramdown::Parser::Kramdown
- #restore_env — Kramdown::Parser::Kramdown
- #revert_pos — Kramdown::Utils::StringScanner
- #root_options — Kramdown::Converter::Pdf
- #save_env — Kramdown::Parser::Kramdown
- #save_pos — Kramdown::Utils::StringScanner
- #setup_document — Kramdown::Converter::Pdf
- #smart_quote_entity — Kramdown::Converter::Base
- #smart_quote_options — Kramdown::Converter::Pdf
- #span_parser_regexps — Kramdown::Parser::Kramdown
- #strong_options — Kramdown::Converter::Pdf
- #table_options — Kramdown::Converter::Pdf
- #text_hash — Kramdown::Converter::Pdf
- #text_options — Kramdown::Converter::Pdf
- #try_require — Kramdown::Document
- #typographic_sym_options — Kramdown::Converter::Pdf
- #ul_options — Kramdown::Converter::Pdf
- #unicode_char — Kramdown::Converter::Man
- #unwrap_links — Kramdown::Converter::Html
- #update_attr_with_ial — Kramdown::Parser::Kramdown
- #update_elements — Kramdown::Parser::GFM
- #update_ial_with_ial — Kramdown::Parser::Kramdown
- #update_link_definitions — Kramdown::Parser::Kramdown
- #update_raw_text — Kramdown::Parser::GFM
- #update_raw_text — Kramdown::Parser::Kramdown
- #update_tree — Kramdown::Parser::Kramdown
- #warning — Kramdown::Converter::Base
- #warning — Kramdown::Parser::Base
- #with_block_padding — Kramdown::Converter::Pdf