Library API

Class Hierarchy

• • Namespace pymdtools
    • Namespace pymdtools::common
      • Class Constant
    • Namespace pymdtools::filetools
      • Class FileContent
      • Class FileName
    • Namespace pymdtools::markdownify
      • Class MarkdownConverter
        • Class MarkdownConverter::DefaultOptions
        • Class MarkdownConverter::Options
    • Namespace pymdtools::mdcommon
      • Class Link
    • Namespace pymdtools::mdfile
      • Class MarkdownContent
    • Namespace pymdtools::mdrender
      • Class MdRenderer
    • Namespace pymdtools::mistunege
      • Class BlockGrammar
      • Class BlockLexer
      • Class InlineGrammar
      • Class InlineLexer
      • Class Markdown
      • Class Renderer

File Hierarchy

• • Directory pymdtools
    • File __init__.py
    • File common.py
    • File filetools.py
    • File instruction.py
    • File markdownify.py
    • File mdcommon.py
    • File mdfile.py
    • File mdrender.py
    • File mdtopdf.py
    • File mistunege.py
    • File normalize.py
    • File translate.py
    • File version.py

Full API

Namespaces

• Namespace pymdtools
  • Namespaces
  • Variables

• Namespace pymdtools::common
  • Classes
  • Functions
  • Variables

• Namespace pymdtools::filetools
  • Classes
  • Functions

• Namespace pymdtools::instruction
  • Functions
  • Variables

• Namespace pymdtools::markdownify
  • Classes
  • Functions
  • Variables

• Namespace pymdtools::mdcommon
  • Classes
  • Functions

• Namespace pymdtools::mdfile
  • Classes

• Namespace pymdtools::mdrender
  • Classes

• Namespace pymdtools::mdtopdf
  • Functions

• Namespace pymdtools::mistunege
  • Classes
  • Functions
  • Variables

• Namespace pymdtools::normalize
  • Functions

• Namespace pymdtools::translate
  • Functions
  • Variables

• Namespace pymdtools::version
  • Variables

Classes and Structs

• Class Constant
  • Class Documentation

• Class FileContent
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation

• Class FileName
  • Inheritance Relationships
    • Derived Type
  • Class Documentation

• Class MarkdownConverter
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class MarkdownConverter::DefaultOptions
  • Nested Relationships
  • Inheritance Relationships
    • Derived Type
  • Class Documentation

• Class MarkdownConverter::Options
  • Nested Relationships
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class Link
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class MarkdownContent
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class MdRenderer
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class BlockGrammar
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class BlockLexer
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class InlineGrammar
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class InlineLexer
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class Markdown
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class Renderer
  • Inheritance Relationships
    • Base Type
  • Class Documentation

Functions

• Function pymdtools::common::__get_this_filename
  • Function Documentation

• Function pymdtools::common::apply_function_in_folder
  • Function Documentation

• Function pymdtools::common::check_create_folder
  • Function Documentation

• Function pymdtools::common::check_folder
  • Function Documentation

• Function pymdtools::common::check_is_file_and_correct_path
  • Function Documentation

• Function pymdtools::common::check_len
  • Function Documentation

• Function pymdtools::common::copytree
  • Function Documentation

• Function pymdtools::common::create_backup
  • Function Documentation

• Function pymdtools::common::filename_ext_to
  • Function Documentation

• Function pymdtools::common::filename_ext_to_chm
  • Function Documentation

• Function pymdtools::common::filename_ext_to_hhc
  • Function Documentation

• Function pymdtools::common::filename_ext_to_hhk
  • Function Documentation

• Function pymdtools::common::filename_ext_to_hhp
  • Function Documentation

• Function pymdtools::common::filename_ext_to_html
  • Function Documentation

• Function pymdtools::common::filename_ext_to_md
  • Function Documentation

• Function pymdtools::common::filename_ext_to_pdf
  • Function Documentation

• Function pymdtools::common::get_file_content
  • Function Documentation

• Function pymdtools::common::get_file_encoding
  • Function Documentation

• Function pymdtools::common::get_flat_filename
  • Function Documentation

• Function pymdtools::common::get_new_temp_dir
  • Function Documentation

• Function pymdtools::common::get_today
  • Function Documentation

• Function pymdtools::common::get_valid_filename
  • Function Documentation

• Function pymdtools::common::handle_exception
  • Function Documentation

• Function pymdtools::common::is_binary_file
  • Function Documentation

• Function pymdtools::common::limit_str
  • Function Documentation

• Function pymdtools::common::number_of_subfolder
  • Function Documentation

• Function pymdtools::common::path_to_url
  • Function Documentation

• Function pymdtools::common::print_conv
  • Function Documentation

• Function pymdtools::common::search_for_file
  • Function Documentation

• Function pymdtools::common::set_correct_path
  • Function Documentation

• Function pymdtools::common::set_file_content
  • Function Documentation

• Function pymdtools::common::simple_decorator
  • Function Documentation

• Function pymdtools::common::slugify
  • Function Documentation

• Function pymdtools::common::static
  • Function Documentation

• Function pymdtools::common::str_to_ascii
  • Function Documentation

• Function pymdtools::common::strip_first_and_last_space
  • Function Documentation

• Function pymdtools::filetools::__get_this_filename
  • Function Documentation

• Function pymdtools::filetools::get_template_file
  • Function Documentation

• Function pymdtools::filetools::get_template_files_in_folder
  • Function Documentation

• Function pymdtools::instruction::__get_this_filename
  • Function Documentation

• Function pymdtools::instruction::del_include_file_to_md_text
  • Function Documentation

• Function pymdtools::instruction::del_var_to_md_text
  • Function Documentation

• Function pymdtools::instruction::get_file_content_to_include
  • Function Documentation

• Function pymdtools::instruction::get_include_file_list
  • Function Documentation

• Function pymdtools::instruction::get_refs_around_md_file
  • Function Documentation

• Function pymdtools::instruction::get_refs_from_md_directory
  • Function Documentation

• Function pymdtools::instruction::get_refs_from_md_file
  • Function Documentation

• Function pymdtools::instruction::get_refs_from_md_text
  • Function Documentation

• Function pymdtools::instruction::get_refs_other
  • Function Documentation

• Function pymdtools::instruction::get_title_from_md_text
  • Function Documentation

• Function pymdtools::instruction::get_vars_from_md_file
  • Function Documentation

• Function pymdtools::instruction::get_vars_from_md_text
  • Function Documentation

• Function pymdtools::instruction::include_files_to_md_file
  • Function Documentation

• Function pymdtools::instruction::include_files_to_md_text
  • Function Documentation

• Function pymdtools::instruction::include_refs_to_md_file
  • Function Documentation

• Function pymdtools::instruction::include_refs_to_md_text
  • Function Documentation

• Function pymdtools::instruction::include_vars_to_md_file
  • Function Documentation

• Function pymdtools::instruction::include_vars_to_md_text
  • Function Documentation

• Function pymdtools::instruction::refs_in_md_text
  • Function Documentation

• Function pymdtools::instruction::search_include_refs_to_md_file
  • Function Documentation

• Function pymdtools::instruction::search_include_vars_to_md_file
  • Function Documentation

• Function pymdtools::instruction::search_include_vars_to_md_text
  • Function Documentation

• Function pymdtools::instruction::set_include_file_to_md_text
  • Function Documentation

• Function pymdtools::instruction::set_title_in_md_text
  • Function Documentation

• Function pymdtools::instruction::set_var_to_md_text
  • Function Documentation

• Function pymdtools::instruction::strip_xml_comment
  • Function Documentation

• Function pymdtools::markdownify::_todict
  • Function Documentation

• Function pymdtools::markdownify::escape
  • Function Documentation

• Function pymdtools::markdownify::markdownify
  • Function Documentation

• Function pymdtools::markdownify::strip_first_last_lf_large
  • Function Documentation

• Function pymdtools::markdownify::strip_first_last_space
  • Function Documentation

• Function pymdtools::markdownify::strip_first_last_space_large
  • Function Documentation

• Function pymdtools::mdcommon::get_domain_name
  • Function Documentation

• Function pymdtools::mdcommon::is_external_link
  • Function Documentation

• Function pymdtools::mdcommon::move_base_path_in_md_text
  • Function Documentation

• Function pymdtools::mdcommon::search_link_in_md_file
  • Function Documentation

• Function pymdtools::mdcommon::search_link_in_md_text
  • Function Documentation

• Function pymdtools::mdcommon::search_link_in_md_text_json
  • Function Documentation

• Function pymdtools::mdcommon::sub_string_link_by_ref_md
  • Function Documentation

• Function pymdtools::mdcommon::sub_string_link_md
  • Function Documentation

• Function pymdtools::mdcommon::sub_string_name_by_ref_md
  • Function Documentation

• Function pymdtools::mdcommon::update_link_from_old_link
  • Function Documentation

• Function pymdtools::mdcommon::update_link_in_md_text
  • Function Documentation

• Function pymdtools::mdcommon::update_links_from_old_link
  • Function Documentation

• Function pymdtools::mdcommon::update_links_in_md_text
  • Function Documentation

• Function pymdtools::mdtopdf::__get_this_filename
  • Function Documentation

• Function pymdtools::mdtopdf::check_odd_pages
  • Function Documentation

• Function pymdtools::mdtopdf::convert_html_to_pdf
  • Function Documentation

• Function pymdtools::mdtopdf::convert_md_to_html
  • Function Documentation

• Function pymdtools::mdtopdf::convert_md_to_pdf
  • Function Documentation

• Function pymdtools::mdtopdf::converter_md_to_html_markdown
  • Function Documentation

• Function pymdtools::mdtopdf::converter_md_to_html_mistune
  • Function Documentation

• Function pymdtools::mdtopdf::find_wk_html_to_pdf
  • Function Documentation

• Function pymdtools::mdtopdf::get_md_to_html_converter
  • Function Documentation

• Function pymdtools::mdtopdf::pdf_features
  • Function Documentation

• Function pymdtools::mistunege::_keyify
  • Function Documentation

• Function pymdtools::mistunege::_pure_pattern
  • Function Documentation

• Function pymdtools::mistunege::escape
  • Function Documentation

• Function pymdtools::mistunege::escape_link
  • Function Documentation

• Function pymdtools::mistunege::markdown
  • Function Documentation

• Function pymdtools::mistunege::preprocessing
  • Function Documentation

• Function pymdtools::normalize::md_beautifier
  • Function Documentation

• Function pymdtools::normalize::md_file_beautifier
  • Function Documentation

• Function pymdtools::translate::__get_this_filename
  • Function Documentation

• Function pymdtools::translate::__get_this_folder
  • Function Documentation

• Function pymdtools::translate::_translation_parameter
  • Function Documentation

• Function pymdtools::translate::eu_lang_list
  • Function Documentation

• Function pymdtools::translate::get_localedir
  • Function Documentation

• Function pymdtools::translate::get_translation
  • Function Documentation

• Function pymdtools::translate::N_
  • Function Documentation

• Function pymdtools::translate::translate
  • Function Documentation

• Function pymdtools::translate::translate_dict
  • Function Documentation

• Function pymdtools::translate::translate_list
  • Function Documentation

• Function pymdtools::translate::translate_md
  • Function Documentation

• Function pymdtools::translate::translate_str
  • Function Documentation

• Function pymdtools::translate::translate_txt
  • Function Documentation

Variables

• Variable pymdtools::__all__
  • Variable Documentation

• Variable pymdtools::__author__
  • Variable Documentation

• Variable pymdtools::__copyright__
  • Variable Documentation

• Variable pymdtools::__credits__
  • Variable Documentation

• Variable pymdtools::__email__
  • Variable Documentation

• Variable pymdtools::__license__
  • Variable Documentation

• Variable pymdtools::__maintainer__
  • Variable Documentation

• Variable pymdtools::__module_name__
  • Variable Documentation

• Variable pymdtools::__status__
  • Variable Documentation

• Variable pymdtools::__version__
  • Variable Documentation

• Variable pymdtools::common::_TEXT_BOMS
  • Variable Documentation

• Variable pymdtools::instruction::__begin_include_re__
  • Variable Documentation

• Variable pymdtools::instruction::__begin_ref_re__
  • Variable Documentation

• Variable pymdtools::instruction::__begin_var_re__
  • Variable Documentation

• Variable pymdtools::instruction::__comment_re__
  • Variable Documentation

• Variable pymdtools::instruction::__end_include_re__
  • Variable Documentation

• Variable pymdtools::instruction::__end_ref_re__
  • Variable Documentation

• Variable pymdtools::instruction::__end_var_re__
  • Variable Documentation

• Variable pymdtools::instruction::__include_file_re__
  • Variable Documentation

• Variable pymdtools::instruction::__var_re__
  • Variable Documentation

• Variable pymdtools::markdownify::ATX
  • Variable Documentation

• Variable pymdtools::markdownify::ATX_CLOSED
  • Variable Documentation

• Variable pymdtools::markdownify::convert_heading_re
  • Variable Documentation

• Variable pymdtools::markdownify::FRAGMENT_ID
  • Variable Documentation

• Variable pymdtools::markdownify::line_beginning_re
  • Variable Documentation

• Variable pymdtools::markdownify::SETEXT
  • Variable Documentation

• Variable pymdtools::markdownify::UNDERLINED
  • Variable Documentation

• Variable pymdtools::markdownify::unicode
  • Variable Documentation

• Variable pymdtools::markdownify::whitespace_re
  • Variable Documentation

• Variable pymdtools::markdownify::wrapped
  • Variable Documentation

• Variable pymdtools::mistunege::__all__
  • Variable Documentation

• Variable pymdtools::mistunege::__author__
  • Variable Documentation

• Variable pymdtools::mistunege::__version__
  • Variable Documentation

• Variable pymdtools::mistunege::_block_code_leading_pattern
  • Variable Documentation

• Variable pymdtools::mistunege::_block_quote_leading_pattern
  • Variable Documentation

• Variable pymdtools::mistunege::_block_tag
  • Variable Documentation

• Variable pymdtools::mistunege::_escape_pattern
  • Variable Documentation

• Variable pymdtools::mistunege::_inline_tags
  • Variable Documentation

• Variable pymdtools::mistunege::_key_pattern
  • Variable Documentation

• Variable pymdtools::mistunege::_newline_pattern
  • Variable Documentation

• Variable pymdtools::mistunege::_nonalpha_pattern
  • Variable Documentation

• Variable pymdtools::mistunege::_pre_tags
  • Variable Documentation

• Variable pymdtools::mistunege::_scheme_blacklist
  • Variable Documentation

• Variable pymdtools::mistunege::_valid_attr
  • Variable Documentation

• Variable pymdtools::mistunege::_valid_end
  • Variable Documentation

• Variable pymdtools::translate::__all__
  • Variable Documentation

• Variable pymdtools::version::__release_date__
  • Variable Documentation

• Variable pymdtools::version::__version_info__
  • Variable Documentation