HTML to Markdown Python

Introduction

Markdown, a lightweight markup style language, allows people to write text that seems structured and simple to read and understand on the web. On the other hand, the Web material has to be marked up and displayed using HTML. Markdown conversion of HTML text can be helpful, for example, if you would like to organize the material or make it more readable.

One approach to convert HTML to Markdown in Python can be using the markdownify module. Text conversion from Markdown to HTML is made quick and reliable through this software. Make sure to download and install markdownify package into your python first and then start the conversion by doing so. If package is installed, it is possible to import it and use its functions to transform HTML text to Markdown.

Installation

You need to install it separately from python package since python does not come with it by default. The command that follows is the module installation. It should be typed into the terminal.

There are multiple steps involved in the process of using Python to convert HTML text to Markdown, as listed below.

Import module:
The markdownify module must be included in your Python script as the first step. This module incorporates a multiplicity of utilities, including converting HTML to Markdown.
Create HTML text:
It is there that the HTML text that you intend to transform to Markdown text is produced. You have two options: writing down the content by hand or downloading the content using Python libraries, such as requests inside a file or from a webpage.
Use the markdownify() function and send the text to it:
Using the markdownify() method provided by the markdown module, you can transform HTML text to Markdown when you've obtained it. This method accepts an HTML text as input and outputs the corresponding Markdown content.
Display markdowned text:
Finally, the Markdown text can be seen in the console or saved to a file by utilizing the built-in Python routines.

The fundamental process would be bringing the necessary module, then inputting the HTML text, and finally executing it through the markdownify() function, which results in Markdown version. This specific technique can be useful for such purpose when you intend to transform HTML information into Markdown so it is easier to read and format.

Example 1: Converting HTML to Markdown

Let's now concentrate on the code that will be used to transform plain HTML to markdown.

Examine the code displayed below. In this code, the markdownify module is the module's first import. After that, we make some HTML content which will automatically transform into Markdown. The highlighted section is an early HTML heading and paragraph.

Next, we evolve the HTML text to the Markdown format with the markdownify() function. This function creates the required Markdown text and emits it right after it receives the HTML content as input.

Example

Lastly, we line this up with the print function to display the translated Markdown. The result is the translated Markdown that goes for the initial HTML input.

Main.py

import markdownify
ht = "<h1>HTML to Markdown Python</h1> 
<p>This is a demonstration code of converting HTML to Markdown in Python</p>"
mt = markdownify.markdownify(ht)
print(mt)

Output

Example 2

Let us look at another example of quite complicated HTML code. Look at the code that is displayed below.

Main.py

import markdownify
ht = """
<div class="article">
   <h1>HTML to Markdown Python</h1> 
<p>This is a demonstration code of converting HTML to Markdown in Python</p>
   <ul>
      <li>Item 1</li>
      <li>Item 2</li>
      <li>Item 3</li>
   </ul>
   <a href="https://www.javatpoint.com">Link to Javatpoint/a>
</div>
"""
mt = markdownify.markdownify(ht)
print(mt)

Output

Conclusion

In conclusion, employing Python to convert HTML to Markdown can be a helpful method for formatting and displaying text on the web. This procedure can be done by employing the markdownify module, which helps to convert html text into markdown format quickly.

Next Topic#

← prev next →