Skip to content

fernandorpm/mischiefer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mischiefer

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

Community

Join our Discord community in order to be on pair with us!

Supporters and Sponsors

Right now we have none of them! 😞 But here's the list of our Supporters!

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.

Contribution

There are many ways to contribute to this project!

No time-consuming and free

  • Use mischiefer! This is the best contribution that you can do for us! ❤️
  • Join our Discord community!
  • Leave a 🌟 on the project! It means a lot to us.
  • Share this framework/repo with someone! And help us grow skyhigh!

Time-consuming but free

  • Report a problem! A good framework is a bug-free framework! Or atleast with well-hidden bugs!
  • Suggest a feature! This way we can compete and stay relevant against other frameworks!
  • Report/Suggest and implement it! This will net you an exclusive contributor tag on Discord!
  • Be active in our Discord community!

No time-consuming but PAID

  • Got a spare penny? Throw it to the chaos! We have a wide variety of donation tags! Both monthly/yearly subscription and one time only!
  • Check our Buy me a Coffee!

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.

About

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

Resources

License

Stars

Watchers

Forks