0.2.1 ā€¢ Published 3 years ago

mischiefer v0.2.1

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

Mischiefer

A free, lightweight, and open-source CSS Framework with inbuilt light and dark themes. Let's cause some mischief!

Installation

Mischiefer can be imported into your project in different ways, but in most cases, it will follow the regular HTML structure:

Notice that the CSS file is added inside the header, while the JS file is added inside the body (normally in the end).

<!DOCTYPE html>
<html>
  <head>
    <link rel="stylesheet" href="CSS_PATH_HERE">
  </head>

  <body>
    <!-- Your wonderful content here -->
    <script src="JS_PATH_HERE"></script>
  </body>

</html>
  1. Import the CSS and the JS files into your HTML files, using the jsdelivr link:
  • CSS: https://cdn.jsdelivr.net/npm/mischiefer@0.2.1/css/mischiefer.min.css
  • JS: https://cdn.jsdelivr.net/npm/mischiefer@0.2.1/js/mischiefer.min.js
  1. Install the Mischiefer Package through npm:
  • npm i mischiefer
  • Import the files into your HTML files:
  • CSS: node_modules/mischiefer/css/mischiefer.min.css
  • JS: node_modules/mischiefer/js/mischiefer.min.js
  1. Download the mischiefer files from Github and import them manually to your project:
  • Import the files into your HTML files, passing down the directory where you added the CSS and JS files.
  1. Use import commands on your main CSS file:
  • @import 'https://cdn.jsdelivr.net/npm/mischiefer@0.2.1/css/mischiefer.min.css';

Important: right now the JS file cannot be imported in the same way as the CSS file. This will be changed in a near future.

Usage

For better infomation about usage, please head to the Documentation.

Issues and Suggestions

Please head to the Issues Page for more information on how to report problems and/or suggest a feature.

Authors

šŸ‘¤ Fernando R P Marques

šŸ‘¤ Arthur Borges

šŸ“ License

This project is MIT licensed.