Markdownify

Warnings

• breaking The interface for custom tag conversion functions (e.g., `convert_*()`) changed significantly in version 1.0.0. If you have custom conversion logic, it will need to be updated.
  Fix: Review the official documentation or GitHub release notes for version 1.0.0 (specifically PR #191) to understand the new function signature and adapt your custom converters accordingly.
• gotcha The `strip` and `convert` options for `markdownify` are mutually exclusive. You cannot use both simultaneously.
  Fix: Choose either the `strip` option to define tags to remove, or the `convert` option to define tags to specifically process. Do not supply both arguments in the same call.
• gotcha When customizing BeautifulSoup parser options via the `beautiful_soup_parser` argument (added in v1.2.0), string or list values are treated as 'features' (e.g., 'lxml', 'html5lib'), while dictionary values are treated as full keyword arguments for the BeautifulSoup constructor.
  Fix: Ensure the format of the `beautiful_soup_parser` argument matches the intended use: pass a string/list for parser features or a dictionary for direct BeautifulSoup constructor kwargs.
• gotcha By default, `markdownify` escapes asterisks (`*`) and underscores (`_`) that might be interpreted as Markdown formatting. If you want to disable this behavior, you need to explicitly set `escape_asterisks=False` or `escape_underscores=False`.
  Fix: Pass `escape_asterisks=False` and/or `escape_underscores=False` as keyword arguments to the `markdownify` function if you want to prevent these characters from being escaped.

Install

• pip install markdownify Install latest version

Imports

• markdownify

  from markdownify import markdownify as md

Quickstart

Convert a basic HTML string to Markdown. The `markdownify` function can be aliased as `md` for convenience.

from markdownify import markdownify as md

html_content = "<h1>Hello World</h1><p>This is <b>bold</b> and <em>italic</em> text with a <a href=\"http://example.com\">link</a>.</p>"
markdown_output = md(html_content)
print(markdown_output)