Skip to content

HereIsKevin/minimal.css

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WARNING: minimal.css is currently in maintenance mode, and will continue to be until I finish my other projects


minimal.css

minimal.css is an easy to use, invasive, and simple minimal css framework. Unlike other minimal frameworks, minimal.css may seem quite large, but is extremely feature rich, with new features being implemented daily. If a large framework like Bootstrap is too heavy for your needs, while a small framework like Skeleton CSS is too basic, minimal.css may be perfect for you. It is fully modular, allowing the user to remove and add components as desired. Each component is completely extensible and configurable, with nearly every value as a Sass variable.

Table of Contents

A Warning to the User

minimal.css is a new creation, and currently under heavy development. Be warned that it is far from complete, and is subject to change often. It is licensed under AGPLv3, so USE AT YOUR OWN RISK. Bugs may occur throughout, and please report them on the issue tracker, so that they may be fixed.

Using

To use minimal.css, copy minimal.css and minimal.js to wherever needed, and add this to your file's <head> include them in your files, replacing the /path/to/s with the actual path of the files:

<link rel="stylesheet" type="text/css" href="/path/to/minimal.css">
<script type="text/javascript" src="/path/to/minimal.js"></script>

In production, it is preferable to use a minified version, so replace copy the minimal.min.css and minimal.min.js instead to wherever needed, and add this instead to your file's <head> to include them in your files, again replacing the /path/to/s with the actual path of the files:

<link rel="stylesheet" type="text/css" href="/path/to/minimal.min.css">
<script type="text/javascript" src="/path/to/minimal.min.js"></script>

Building

Building minimal.css is relatively easy, with prewritten build scripts, though every source release comes with everything prebuilt. Before doing anything, make sure Node.js is installed and on the path, and NPM is also installed with it.

Windows

On Windows, open PowerShell and issue the following commands:

npm install # Installs the dependencies
npm run build-win # Runs the Windows build script

For more options, run .\build_res\build.ps1 --help, and then execute .\build_res\build.ps1 instead of npm run build-win

Linux, macOS, and other *NIXs

On Linux, macOS, or other *NIXs with bash, open a shell and run:

npm install # Installs the dependencies
npm run build-nix # Runs the *nix build script.

For more options, run ./build_res/build.sh --help, and then execute ./build_res/build.sh instead of npm run build-nix

Issues

Bugs are common, so please report them on the issue tracker.

Licensing

I believe that a work of open source should stay open, along with all the contributions to the code, as improvements should always be shared, so I decided to license this project under AGPLv3, which you can see the restrictions here.


This project Copyright © 2019 Kevin Feng, licensed under AGPLv3, as free and open source software. All rights reserved. Note that all rights to relicense, the source code, and all intelectual property belongs to Kevin Feng.

About

An easy to use and simple yet elegant minimal css framework

Resources

License

Stars

Watchers

Forks

Packages

No packages published