@beetle/bee-grid

BeeGrid

A microframework based on CSS Grid Layout to build various types of grids thanks to a twelve column system, five default responsive tiers, Sass variables and mixins, and dozens of predefined classes to organize your content.

Table of contents

• Table of contents
• Quick start
• Files
• Bugs and feature requests
• Documentation
  • You can find the docs at: https://davidedantonio.github.io/bee-grid/documentation/1.0/introduction/
  • Running documentation locally
• Contributing
• Creators
• Copyright and license

Quick start

Several quick start options are available:

• Download the latest release.
• Clone the repo: https://github.com/davidedantonio/bee-grid.git
• Install with npm: npm install @beetle/bee-grid
• Install with yarn: yarn add @beetle/bee-grid

Files

Within the download you'll find the following directories and files, providing both compiled and minified variations. You'll see something like this:

dist
 ├── css/
 │    ├── bee-grid.css
 │    ├── bee-grid.css.map
 │    ├── bee-grid.min.css
 │    └── bee-grid.min.css.map
 └── js/
      ├── navbar.js
      ├── navbar.js.map
      ├── navbar.min.js
      └── navbar.min.css.js

Bugs and feature requests

Have a bug or a feature request? Search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

You can find the docs at: https://davidedantonio.github.io/bee-grid/documentation/1.0/introduction/

Beegrid's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at https://davidedantonio.github.io/bee-grid/. The docs may also be run locally.

Running documentation locally

1. Install Jekyll (the site builder) and other Ruby dependencies with bundle install.
2. Run npm install to install Node.js dependencies.
3. Run a specific NPM script to rebuild distributed CSS and JavaScript files, as well as our docs assets.
4. From the root /bee-grid directory, run npm run docs-serve in the command line.
5. Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Contributing

Solutions and improvements are always accepted. Please create a pull request here

Creators

Davide D'Antonio

• https://twitter.com/davidedantonio
• https://github.com/davidedantonio

Riccardo Tartaglia

• https://twitter.com/RikTarWeb
• https://github.com/riktar

Copyright and license

Code released under the MIT License.