How To Install mkdocs on Kali Linux

Introduction

In this tutorial we learn how to install mkdocs on Kali Linux.

What is mkdocs

mkdocs is:

MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

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

Install mkdocs Using apt-get

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

sudo apt-get update

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

sudo apt-get -y install mkdocs

Install mkdocs Using apt

Update apt database with apt using the following command.

sudo apt update

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

sudo apt -y install mkdocs

Install mkdocs Using aptitude

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

sudo aptitude update

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

sudo aptitude -y install mkdocs

How To Uninstall mkdocs on Kali Linux

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

sudo apt-get remove mkdocs

Uninstall mkdocs And Its Dependencies

To uninstall mkdocs and its dependencies that are no longer needed by Kali Linux, we can use the command below:

sudo apt-get -y autoremove mkdocs

Remove mkdocs Configurations and Data

To remove mkdocs configuration and data from Kali Linux we can use the following command:

sudo apt-get -y purge mkdocs

Remove mkdocs configuration, data, and all of its dependencies

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

sudo apt-get -y autoremove --purge mkdocs

Dependencies

mkdocs have the following dependencies:

• fonts-font-awesome
• libjs-bootstrap4
• libjs-jquery
• libjs-lunr
• libjs-modernizr
• python3-pkg-resources
• sphinx-rtd-theme-common
• python3-click
• python3-jinja2
• python3-livereload
• python3-markdown
• python3-tornado
• python3-yaml
• python3

References

• mkdocs website

Summary

In this tutorial we learn how to install mkdocs package on Kali Linux using different package management tools: apt, apt-get and aptitude.