Installation

Blinds is a package used to easily add dark mode to a website. But before using blinds, it has to be set up in your project. This guide contains instructions for setting up blinds for use in your website.

Getting blinds

You can get blinds in 2 ways:

  • 1. Via CDN, and
  • 2. Via NPM

The method you choose will largely depend on how you are building (or built) your website.
If you are building your website using NPM and NPM packages, for example React, then you will want to get blinds via NPM. Otherwise, you should get blinds into your project via CDN. We will first deal with getting blinds via CDN, and then afterwards via NPM.

Via CDN

If you wish to make use of the NPM option instead, you can skip this section. Click this link to jump to the NPM section.

To get blinds via CDN, add the following code to your HTML:


<script src="https://cdn.jsdelivr.net/gh/Ikennaf1/blinds@latest/dist/blinds.min.js" defer></script>

Via NPM

To get blinds via NPM, open your terminal and make sure you are in your project's root directory.
Run the following command in your root directory to get blinds install to your project:


npm install --save blinds