Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 1.65 KB

bootstrap-nightshade.md

File metadata and controls

53 lines (40 loc) · 1.65 KB
Raw

Bootstrap-Nightshade Quick Start

A basic HTML file should look like this:

<!doctype html>
<html lang="en">
  <head>
    <!-- Required meta tags -->
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <!-- The page supports both dark and light color schemes,
         and the page author prefers / default is light. -->
    <meta name="color-scheme" content="light dark">

    <!-- Replace the Bootstrap CSS with the
         Bootstrap-Dark Variant CSS -->
    <link href="https://cdn.jsdelivr.net/npm/bootstrap-dark-5@1.1.3/dist/css/bootstrap-nightshade.min.css" rel="stylesheet">

    <title>Hello, world!</title>
  </head>
  <body>
    <!-- ////////////// -->
    <!-- Your HTML here -->
    <!-- \\\\\\\\\\\\\\ -->

    <!-- Optional Bootstrap JavaScript -->
    <script src="location/of/the/bootstrap.js/here"></script>

    <!-- Required DarkMode JavaScript -->
    <script src="https://cdn.jsdelivr.net/npm/bootstrap-dark-5@1.1.3/dist/js/darkmode.min.js"></script>
  </body>
</html>

That's all. The page will automatically transition to Dark Mode when the users sets their OS to Dark Mode.

Refer to the Bootstrap 5 Docs for more help.

If you wish to add a Dark Mode Toggle button, simply add the following:

    <script>
      document.querySelector("#your-darkmode-button-id").onclick = function(e){
        darkmode.toggleDarkMode();
      }
    </script>

Refer to the darkmode.js Reference for more on the darkmode JavaScript object.