@materialstyle/materialstyle

Material Style

A Material Design UI Library based on Bootstrap.

Table of contents

• Components
• Getting Started
• Bugs and feature requests
• Documentation
• Contributing
• Creator
• Thank you

Components

https://materialstyle.github.io/materialstyle/3.1/components/alert/

Getting Started

https://materialstyle.github.io/materialstyle/3.1/getting-started/installation/

Bugs and feature requests

Have a bug or a feature request? Please read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

Material Style's documentation, included in this repo in the root directory, is built with Hugo and publicly hosted on GitHub Pages at https://materialstyle.github.io/. The docs may also be run locally.

Running documentation locally

1. Run npm install to install the Node.js dependencies, including Hugo (the site builder).
2. From the root /materialstyle directory, run npm run docs-serve in the command line.
3. Open http://localhost:9001/materialstyle in your browser, and voilà.

Learn more about using Hugo by reading its documentation.

Contributing

Please read through our contributing guidelines. 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, maintained by Mark Otto.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org/.

Creator

Neeraj Kumar Das

• https://github.com/nkdas91
• https://neerajdas.com/

Thank you!

Thank you Bootstrap for an awesome front-end framework!

Thank you BrowserStack for providing the infrastructure that allows us to test in real browsers!

Thank you Netlify for providing us with Deploy Previews!