mdb-ui-kit/docs/getting-started/download.md

3.2 KiB

layout title group
docs Download getting-started

Material Design for Bootstrap v{{ site.current_version}} is available for download in several ways, including some of your favorite package managers. Choose from the options below to snag just what you need.

{% markdown %} ### Compiled Download just the compiled and minified CSS and JavaScript. Doesn't include any documentation or original source files.

{% comment %} Download Material Design for Bootstrap {% endcomment %} Coming soon! {% endmarkdown %}

{% markdown %} ### Source files Download everything: source Sass, JavaScript, and documentation files. **Requires a Sass compiler, [Autoprefixer](https://github.com/postcss/autoprefixer), and [some setup]({{ site.baseurl }}/getting-started/build-tools/#tooling-setup).**

Download source {% endmarkdown %}

Package managers

Pull in Material Design for Bootstrap's source files into nearly any project with some of the most popular package managers. No matter the package manager, Material Design for Bootstrap will require a Sass compiler and Autoprefixer for a setup that matches our official compiled versions.

{% callout warning %} Heads up! Not all package managers have the v4 alpha published yet, but we should have them up shortly! {% endcallout %}

Bower

Install and manage Material Design for Bootstrap's Sass and JavaScript using Bower.

{% highlight bash %}$ bower install bootstrap-material-design#v{{ site.current_version }}{% endhighlight %}

npm

Install Material Design for Bootstrap in your Node powered apps with the npm package:

{% highlight bash %}$ npm install bootstrap@{{ site.current_version }}{% endhighlight %}

require('bootstrap-material-design') will load all of Material Design for Bootstrap's jQuery plugins onto the jQuery object. The bootstrap module itself does not export anything. You can manually load Material Design for Bootstrap's jQuery plugins individually by loading the /js/*.js files under the package's top-level directory.

Material Design for Material Design for Bootstrap's package.json contains some additional metadata under the following keys:

  • sass - path to Material Design for Bootstrap's main Sass source file
  • style - path to Material Design for Bootstrap's non-minified CSS that's been precompiled using the default settings (no customization)

Meteor

{% highlight bash %} $ meteor add FezVrasta/bootstrap-material-design@={{ site.current_version }} {% endhighlight %}

Composer

You can also install and manage Material Design for Bootstrap's Sass and JavaScript using Composer:

{% highlight bash %} $ composer require FezVrasta/bootstrap-material-design {% endhighlight %}