@materializecss/materialize

Materialize

Materialize, a CSS Framework based on Material Design.
[ Browse the docs ]

Quickstart

Read the getting started guide for more information on how to use materialize.

Download the latest release of materialize directly from GitHub. (Beta)
Clone the repo: git clone https://github.com/materializecss/materialize.git
Include the files via jsDelivr.
Install with npm: npm install @materializecss/materialize (Beta: npm install @materializecss/materialize@next)

Development

The documentation can be found at https://materializeweb.com. To run the documentation locally on your machine, you need Node.js installed on your computer.

This is the core project with all the components. To see how they are used we recommend using an example project or go to the documentation. Otherwise, if you want to develop the components itself, the dev process of this core-repo works like this:

npm install
npm run dev

Running documentation locally

See Materialize Docs Repo to see Materialize in Action.

Documentation for previous releases

Previous releases are available here.

Release

If you want to release materialize.css or materialize.js from the latest commit, you can build the files with the following command after npm install. See package.json to check the current version like 1.0.0.

npm run release -- --oldver=<current_version> --newver=<new_version>

Supported Browsers:

Materialize is compatible with:

Chrome 35+
Firefox 31+
Safari 9+
Opera
Edge

Changelog

For changelogs, check out the Releases section of materialize or the CHANGELOG.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 the CONTRIBUTING document in the root of the repository to learn how you can contribute. You can also browse the help-wanted tag in our issue tracker to find things to do.