magical-css
Version:
A simple, unique, and responsive CSS framework, made with SASS.
50 lines (40 loc) • 2.88 kB
Markdown
<p align="center">
<a href="https://palkerecsenyi.github.io/magic/docs/">
<img src="https://palkerecsenyi.github.io/magic/documentation/media/icon.svg" width="80">
</a>
<h1 align="center" style="margin-top:0;">Magic.CSS</h1>
</p>
<p align="center">Magic.CSS is a <strong>simple and responsive CSS library</strong>, made with SASS. It's inspired by (though not directly derived from) Bootstrap and Materialize. Each component is made with minimal markup to increase neatness, and they come with extensive, user-friendly <a href="https://palkerecsenyi.github.io/magic/docs/">documentation</a>.</p>
<p align="center">
<a href="https://travis-ci.org/palkerecsenyi/magic"><img src="https://travis-ci.org/palkerecsenyi/magic.svg?branch=master"></a>
<a href="https://www.npmjs.com/package/magical-css"><img src="https://img.shields.io/npm/v/magical-css.svg" alt="npm version"></a>
<a href="https://www.jsdelivr.com/package/npm/magical-css"><img src="https://data.jsdelivr.com/v1/package/npm/magical-css/badge"></a>
<a href="https://www.npmjs.com/package/magical-css"><img src="https://img.shields.io/npm/dt/magical-css.svg"></a>
<a href="https://gitter.im/magic-css/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link"><img src="http://badges.gitter.im/magic-css.png"></a>
</p>
### Setup
To set up Magic on your website, simply add this to the `<head>` of your page:
```HTML
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/magical-css@latest/dist/magic.css">
```
Please note that if a new version of Magic is released, your website will receive it automatically, which may mean that some parts of your page change. To get a fixed version, see the jsDelivr docs: https://www.jsdelivr.com.
To install Magic, uncompiled SCSS, docs and more, do one of the following:
```bash
npm install magical-css
```
```bash
yarn add magical-css
```
```bash
bower install magical-css
```
Clone https://github.com/palkerecsenyi/magic.git
For the proper functionality of Magic, please double check that the fonts are linked correctly at the start of `dist/magic.css`. If using a CDN, this works automatically.
### Usage
Magical Library tries to avoid default styles (globally referencing elements rather than classes) wherever possible, to make it as non-destructive in complex projects as possible. Class names are designed to be very evident. For a full usage guide, see the Wiki of this repository.
### Attributions
Two fonts are used: `Noto Sans` by Google and `Roboto` by Christian Robertson.
### Documentation
To use Magic, you'll need to read the official documentation. It's currently available through Github pages at https://palkerecsenyi.github.io/magic/docs/. The documentation is, in fact, made with Magic!
That's it. Enjoy!