How To Install jsdoc-toolkit on Ubuntu 20.04

In this tutorial we learn how to install jsdoc-toolkit on Ubuntu 20.04. jsdoc-toolkit is automatic generator for HTML documentation of Javascript sources

Introduction

In this tutorial we learn how to install jsdoc-toolkit on Ubuntu 20.04.

What is jsdoc-toolkit

jsdoc-toolkit is:

JsDoc Toolkit is an application, written in JavaScript, for automatically generating template-formatted, multi-page HTML (or XML, JSON, or any other text-based) documentation from commented JavaScript source code.

Based on the JSDoc.pm project, this was renamed “Jsdoc Toolkit” during development as it grew into more than a simple version upgrade.

There are three methods to install jsdoc-toolkit on Ubuntu 20.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 jsdoc-toolkit Using apt-get

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

sudo apt-get update

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

sudo apt-get -y install jsdoc-toolkit

Install jsdoc-toolkit Using apt

Update apt database with apt using the following command.

sudo apt update

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

sudo apt -y install jsdoc-toolkit

Install jsdoc-toolkit 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 jsdoc-toolkit using aptitude by running the following command:

sudo aptitude -y install jsdoc-toolkit

How To Uninstall jsdoc-toolkit on Ubuntu 20.04

To uninstall only the jsdoc-toolkit package we can use the following command:

sudo apt-get remove jsdoc-toolkit

Uninstall jsdoc-toolkit And Its Dependencies

To uninstall jsdoc-toolkit and its dependencies that are no longer needed by Ubuntu 20.04, we can use the command below:

sudo apt-get -y autoremove jsdoc-toolkit

Remove jsdoc-toolkit Configurations and Data

To remove jsdoc-toolkit configuration and data from Ubuntu 20.04 we can use the following command:

sudo apt-get -y purge jsdoc-toolkit

Remove jsdoc-toolkit configuration, data, and all of its dependencies

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

sudo apt-get -y autoremove --purge jsdoc-toolkit

References

Summary

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