Skip to content

Dogfalo/materialize

Repository files navigation

MaterializeCSS

Materialize, a CSS Framework based on material design.
-- Browse the docs --

Travis CI badge npm version badge CDNJS version badge dependencies Status badge devDependency Status badge Gitter badge

Table of Contents

Quickstart:

Read thegetting started guidefor more information on how to use materialize.

  • Download the latest releaseof materialize directly from GitHub. (Beta)
  • Clone the repo:git clone https://github /Dogfalo/materialize.git(Beta:git clone -b v1-dev https://github /Dogfalo/materialize.git)
  • Include the files viacdnjs.Morehere.(Beta)
  • Install withnpm:npm install materialize-css(Beta:npm install materialize-css@next)
  • Install withBower:bower install materialize(DEPRECATED)
  • Install withAtmosphere:meteor add materialize:materialize(Beta:meteor add materialize:materialize@=1.0.0-beta)

Documentation

The documentation can be found athttp://materializecss.To run the documentation locally on your machine, you needNode.jsinstalled on your computer.

Running documentation locally

Run these commands to set up the documentation:

git clone https://github /Dogfalo/materialize
cdmaterialize
npm install

Then rungrunt monitorto compile the documentation. When it finishes, open a new browser window and navigate tolocalhost:8000.We useBrowserSyncto display the documentation.

Documentation for previous releases

Previous releases and their documentation are available fordownload.

Supported Browsers:

Materialize is compatible with:

  • Chrome 35+
  • Firefox 31+
  • Safari 9+
  • Opera
  • Edge
  • IE 11+

Changelog

For changelogs, check outthe Releases section of materializeor theCHANGELOG.md.

Testing

We use Jasmine as our testing framework and we're trying to write a robust test suite for our components. If you want to help,here's a starting guide on how to write tests in Jasmine.

Contributing

Check out theCONTRIBUTING documentin the root of the repository to learn how you can contribute. You can also browse thehelp-wantedtag in our issue tracker to find things to do.

Copyright and license

Code Copyright 2018 Materialize. Code released under the MIT license.