How To Install m2r on Ubuntu 22.04

In this tutorial we learn how to install m2r on Ubuntu 22.04. m2r is Markdown and reStructuredText in a single file - CLI tool

Introduction

In this tutorial we learn how to install m2r on Ubuntu 22.04.

What is m2r

m2r is:

M2R converts a markdown file including reStructuredText (rst) markups to a valid rst format.

Use case is writing sphinx document in markdown, since it’s widely used now and easy to write code blocks and lists. However, converters using pandoc or recommonmark do not support many rst markups and sphinx extensions. For example, rst’s reference link like see `ref`_ (this is very convenient in long document in which same link appears multiple times) will be converted to a code block in HTML like see ref</code>_, which is not expected.

This package provides the command-line tool m2r.

There are three methods to install m2r on Ubuntu 22.04. We can use apt-get, apt and aptitude. In the following sections we will describe each method. You can choose one of them.

Install m2r Using apt-get

Update apt database with apt-get using the following command.

sudo apt-get update

After updating apt database, We can install m2r using apt-get by running the following command:

sudo apt-get -y install m2r

Install m2r Using apt

Update apt database with apt using the following command.

sudo apt update

After updating apt database, We can install m2r using apt by running the following command:

sudo apt -y install m2r

Install m2r Using aptitude

If you want to follow this method, you might need to install aptitude first since aptitude is usually not installed by default on Ubuntu. Update apt database with aptitude using the following command.

sudo aptitude update

After updating apt database, We can install m2r using aptitude by running the following command:

sudo aptitude -y install m2r

How To Uninstall m2r on Ubuntu 22.04

To uninstall only the m2r package we can use the following command:

sudo apt-get remove m2r

Uninstall m2r And Its Dependencies

To uninstall m2r and its dependencies that are no longer needed by Ubuntu 22.04, we can use the command below:

sudo apt-get -y autoremove m2r

Remove m2r Configurations and Data

To remove m2r configuration and data from Ubuntu 22.04 we can use the following command:

sudo apt-get -y purge m2r

Remove m2r configuration, data, and all of its dependencies

We can use the following command to remove m2r configurations, data and all of its dependencies, we can use the following command:

sudo apt-get -y autoremove --purge m2r

References

Summary

In this tutorial we learn how to install m2r package on Ubuntu 22.04 using different package management tools: apt, apt-get and aptitude.