materialize README

The project's README from github.com/Dogfalo/materialize. As one markdown file: README.md.

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 the getting started guide for more information on how to use materialize.

Documentation

The documentation can be found at http://materializecss.com. 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/Dogfalo/materialize
cd materialize
npm install

Then run grunt monitor 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.

Supported Browsers:

Materialize is compatible with:

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.

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

materialize (Dogfalo/materialize)

Searching Database…

38.8K ·GitHub
Materialize
What is this?Materialize is a CSS framework implementing Google's Material Design, providing ready-made UI components, grid system, and styling for building responsive websites.
Is it a framework or a library?It is a CSS framework: a set of pre-built styles and JavaScript components for buttons, cards, modals, navigation and more, following Material Design guidelines.
How do I add it to a project?You can download the latest release, clone the repo, include it via the cdnjs CDN, install with npm (materialize-css), or use Bower/Atmosphere (both deprecated).
Do I need Node.js to use it?No, Node.js is only needed if you want to build or run the documentation site locally; using the framework itself just requires including the CSS/JS files.
Are Bower and Atmosphere install methods still maintained?The Bower install method is explicitly marked as deprecated in the README, so npm or CDN are the recommended ways to get it.
Which browsers does it support?Materialize targets modern and legacy browsers including Chrome 35+, Firefox 31+, Safari 9+, Opera, Edge, and IE 11+.
Is there a beta or newer version available?Yes, the README mentions a Beta track with its own branch (v1-dev) and npm tag (materialize-css@next) alongside the stable release.
How is it tested?The project uses Jasmine as its testing framework for building out a test suite covering the components.
Can I still get documentation for older releases?Yes, previous releases and their corresponding documentation are available for download separately.
What are similar projects?mdb-ui-kit, vuetify, material-design-lite, uikit, bootstrap-table, daisyui, bulma, weui
Which topics is it in?material, css3, css-framework, ui-kit, html5, responsive, ui-library, material-design, component-library, design, ui-components, css
Creator
Dogfalo
Size
162 MB
Stars
38.8K
Updated
CommitJun 01Release1.0.0Sep 09
Age
12y
Commits · 90 Days