0.5.0 • Published 6 years ago

meshcss v0.5.0

Weekly downloads
4
License
MIT
Repository
github
Last release
6 years ago

CodeFactor Discord Chat known vulnerabilities contributions welcome dependency status GitHub license

Why? start with why

Versatile

It's based on the principle that every website is different. Most CSS frameworks have consistent styling, you can almost tell if a website was designed with a particular one. Here, we use wire-framing to show you what it could look like, not what it will look like.

Fast

It's quick - under 100kb minified. mesh was built with a very modular approach, meaning you can cut back on classes & components you won't use by using our scss files.

Functional

It has a huge amount of very useful utility classes, it's also built entirely around flex box, which enables you to write HTML quicker. It's extremely easy to pick up and will save you bags of time in the long run.

Installation

  • To begin with, download or clone this repository
  • Under copy dist , copy mesh.min.css to your site's css folder.
  • Add stylesheet declaration in <head>
<link rel="stylesheet" type="text/css" href="path-to-stylesheet/mesh.min.css" />

Docs

meshcss.com is underway, you can view the temporary documentation here

Contributing

mesh is still in its early days, if you wish to contribute, please do so! It would be appreciated. Please email info@ainsleyclark.com if you have any questions, I will be more than happy to answer them.

How to contribute:

  1. Clone this repo and create a new branch.
  2. Using node/npm enter npm install to install dev dependencies.
  3. If you have vagrant, use 'npm run dev' to boot up vagrant box (trusty64) and watch & compile sass.
  4. If you use docker, use 'npm run docker-create' in the mesh base dir to create a docker container and 'npm run docker-start' to start the container and watch & compile sass.
  5. If you do not have vagrant, use 'npm run watch-css' to watch & compile sass.
  6. When finished use npm run prod to clean compiled css files.
  7. Merge & commit, create new pull request.

Notes:

  • Please do not edit mesh.css directly, they are automatically generated.
  • Get yourself familiar with the demo pages to see how things work.

Licence

Code Copyright 2018 mesh. Code released under the MIT Licence.

Contributors

@kassuro @nicholsk18 @versustune

Testing

Tested with BrowserStack.