Table of Contents

• Quickstart
• Documentation
• Build
• Supported Browsers
• Changelog
• Testing
• Contributing
• Copyright and license

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 (Beta: git clone -b v1-dev https://github.com/materializecss/materialize.git)
• Include the files via jsDelivr.
• Install with npm: npm install @materializecss/materialize (Beta: npm install @materializecss/materialize@next)

Documentation

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

Running documentation locally

Run these commands to set up the documentation:

git clone https://github.com/materializecss/materialize
cd materialize
npm install

Then run npm run dev to compile the documentation. When it finishes, open a new browser window and navigate to localhost:8000. We use BrowserSync to display the documentation.

Documentation for previous releases

Previous releases and their documentation are available for download.

Build

If you want to build 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
• IE 11+

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.

Copyright and license

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