scss-flexbox-grid
v2.0.1
Published
Flexbox-based grid system for responsive design.
Downloads
5
Maintainers
Readme
Flex-Grid
Flexbox based grid system for responsive design.
Flex-Grid is an SCSS framework with the purpose of simplifying responsive design. Using BEM naming conventions, classes are written alongside HTML in order to ensure that CSS is not overly-dependent on markup. Different designs are possible at each breakpoint through a mobile-first design strategy.
Usage
There are currently two ways to support Flex-Grid in your projects:
- Clone the repository
- Download the node module
Clone the repository
git clone https://github.com/NoahT/Flex-Grid.git
cd Flex-Grid
Download the node module
Before installing as a node module, make sure that Node.js is already installed.
npm init
npm i --save scss-flexbox-grid
After installing, link the compiled CSS file (from the root directory) ./css/bem-grid-system.css
to any HTML files in order to use it.
Documentation
Documentation on using Flex-Grid can be found here.
Contributing/Issues
Found something wrong with Flex-Grid? Please post a new issue.
If you are looking to contribute:
- Propose a new issue with the enhancement tag
- Once approved, fork the repository
- Make the necessary changes and test to see if it works
- Make a pull request
When making a pull request, make sure to exclude any testing done inside of a .GITIGNORE
file.
License
Flex-Grid is an open-sourced project under the MIT license.