mirror of
https://github.com/mdbootstrap/mdb-ui-kit.git
synced 2024-11-22 17:47:11 +03:00
57 lines
3.4 KiB
Markdown
57 lines
3.4 KiB
Markdown
# bootstrap-material-design
|
|
|
|
## **WARNING:** These docs relate to the next major release and integration with bootstrap V4.
|
|
|
|
[](https://gratipay.com/FezVrasta)
|
|
|
|
|
|
Bootstrap Material Design is the best way to use [Material Design guidelines by Google](http://www.google.com/design/spec/material-design/introduction.html)
|
|
in your Bootstrap 4 based application. Since this is a fully customizable version of Bootstrap,
|
|
just include Bootstrap Material Design CSS instead of Bootstrap CSS, and include the JavaScript at
|
|
the end of your document (just before the `</body>` tag), and everything will be converted to Material Design.
|
|
|
|
## Documentation
|
|
|
|
NOTE: this is a temporary site location that will be published in at http://fezvrasta.github.io/bootstrap-material-design in the future.
|
|
|
|
- [Getting Started](http://rosskevin.github.io/bootstrap-material-design/getting-started/introduction/)
|
|
- [Building](http://rosskevin.github.io/bootstrap-material-design/getting-started/building/)
|
|
- [Material Design components](http://rosskevin.github.io/bootstrap-material-design/material-design/list-groups/)
|
|
- [Bootstrap default rendering reference documentation](http://rosskevin.github.io/bootstrap-material-design/components/buttons/)
|
|
- [Migration](http://rosskevin.github.io/bootstrap-material-design/migration/)
|
|
|
|
## Support
|
|
|
|
If you like this project you may support it by donating via Gittip, starring this repository or reporting issues.
|
|
All issues filed should be reduced to a [CodePen](http://codepen.io/rosskevin/pen/eJMMVB) test case where possible.
|
|
|
|
[](https://www.gratipay.com/FezVrasta/)
|
|
[](https://github.com/FezVrasta/bootstrap-material-design/issues)
|
|
|
|
|
|
## Contributing
|
|
|
|
### During V4 major development
|
|
If you want to get involved, please do so by submitting pull requests. Before undertaking any major PR effort, please check the [milestone](https://github.com/FezVrasta/bootstrap-material-design/milestones/V4) for an existing issue. If there isn't one, please file a new issue and `cc: @rosskevin` so we can discuss and assign the work so effort is not duplicated. Thank you!
|
|
|
|
Please prefix any issue or pull request title with `V4`.
|
|
|
|
### Standard guidelines
|
|
Please read through our [contributing guidelines](CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
|
|
|
|
Moreover, if your pull request contains JavaScript patches or features, you must include relevant unit tests. All HTML and CSS should conform to the [Code Guide](http://codeguide.co/), maintained by [Mark Otto](https://github.com/mdo), one of Bootstrap's founders.
|
|
|
|
Editor preferences are available in the [editor config](https://github.com/FezVrasta/bootstrap-material-design/blob/master/.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
|
|
|
|
## Versioning
|
|
|
|
For transparency into our release cycle and in striving to maintain backward compatibility, this project is maintained under
|
|
[the Semantic Versioning guidelines](http://semver.org/). Sometimes we screw up, but we'll adhere to those rules whenever possible.
|
|
|
|
See [the Releases section of our GitHub project](https://github.com/fezvrasta/bootstrap-material-design/releases) for changelogs
|
|
of each release version.
|
|
|
|
|
|
## License
|
|
[MIT License](LICENSE.md)
|