<!-- THIS FILE IS AUTO-GENERATED. PLEASE EDIT `.readme/lang/README.base.md` AND RUN `npm run mmg`. -->

# ![Material Board](/.readme/banner.png?raw=true  "Material Board")

The Material Board plugin for WordPress updates the appearance of your site's dashboard to a sleeker, more contemporary design based on [Google's Material Design Guidelines](https://material.io/design). This plugin preserves your existing dashboard layout, avoids making any significant alterations, and doesn't include any branding or promotional content. It's straightforward to use and comes at no cost.

![Prerelease](https://img.shields.io/badge/pre--release-red?style=for-the-badge)
[![Download](https://img.shields.io/badge/-Download-2246CC?style=for-the-badge&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj48c3ZnIHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIHZpZXdCb3g9IjAgMCA0OCA0OCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4bWw6c3BhY2U9InByZXNlcnZlIiB4bWxuczpzZXJpZj0iaHR0cDovL3d3dy5zZXJpZi5jb20vIiBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQ7Y2xpcC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjI7Ij48cGF0aCBkPSJNMTEsNDBjLTAuOCwwIC0xLjUsLTAuMyAtMi4xLC0wLjljLTAuNiwtMC42IC0wLjksLTEuMyAtMC45LC0yLjFsMCwtNy4xNWwzLC0wbDAsNy4xNWwyNiwwbDAsLTcuMTVsMywtMGwwLDcuMTVjMCwwLjggLTAuMywxLjUgLTAuOSwyLjFjLTAuNiwwLjYgLTEuMywwLjkgLTIuMSwwLjlsLTI2LDBabTEzLC03LjY1bC05LjY1LC05LjY1bDIuMTUsLTIuMTVsNiw2bDAsLTE4LjU1bDMsLTBsMCwxOC41NWw2LC02bDIuMTUsMi4xNWwtOS42NSw5LjY1WiIgc3R5bGU9ImZpbGw6I2ZmZjtmaWxsLXJ1bGU6bm9uemVybzsiLz48L3N2Zz4=)](https://github.com/fatihbalsoy/material-board/releases/)
[![Demo](https://img.shields.io/badge/-Demo-446DFF?style=for-the-badge&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+PCFET0NUWVBFIHN2ZyBQVUJMSUMgIi0vL1czQy8vRFREIFNWRyAxLjEvL0VOIiAiaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkIj48c3ZnIHdpZHRoPSIxMDAlIiBoZWlnaHQ9IjEwMCUiIHZpZXdCb3g9IjAgMCA0OCA0OCIgdmVyc2lvbj0iMS4xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4bWw6c3BhY2U9InByZXNlcnZlIiB4bWxuczpzZXJpZj0iaHR0cDovL3d3dy5zZXJpZi5jb20vIiBzdHlsZT0iZmlsbC1ydWxlOmV2ZW5vZGQ7Y2xpcC1ydWxlOmV2ZW5vZGQ7c3Ryb2tlLWxpbmVqb2luOnJvdW5kO3N0cm9rZS1taXRlcmxpbWl0OjI7Ij48cGF0aCBkPSJNMTYsMzcuODVsMCwtMjhsMjIsMTRsLTIyLDE0Wm0zLC01LjQ1bDEzLjQ1LC04LjU1bC0xMy40NSwtOC41NWwwLDE3LjFaIiBzdHlsZT0iZmlsbDojZmZmO2ZpbGwtcnVsZTpub256ZXJvOyIvPjwvc3ZnPg==)](https://material-dashboard-demo.bal.soy/)

[![WordPress](https://img.shields.io/badge/WordPress-6.5-lightblue?style=for-the-badge&logo=wordpress&logoWidth=20)](https://wordpress.org/plugins/material-board/)
[![Build Status](https://img.shields.io/github/actions/workflow/status/fatihbalsoy/material-board/build.yml?style=for-the-badge&logo=github)](https://github.com/fatihbalsoy/material-board/actions/workflows/build.yml)

Read this document in a different language.

[![English](https://img.shields.io/badge/-English-blue?style=for-the-badge)](/README.md)
[![Turkish](https://img.shields.io/badge/-T%C3%BCrk%C3%A7e-red?style=for-the-badge)](/.readme/lang/README.tr.md)

[![Crowdin](https://badges.crowdin.net/material-dashboard/localized.svg)](https://crowdin.com/project/material-dashboard)

## Screenshots

![Screenshots](/.readme/dashboard-welcome.png?raw=true  "Screenshots")
![Screenshots](/.readme/screenshots.png?raw=true  "Screenshots")

## Installation

Material Board is available on the WordPress Plugin Directory [(link)](https://wordpress.org/plugins/material-board/) and can be installed from the plugins page in your admin dashboard.

### Manually

* Download the latest release of Material Board [here](https://github.com/fatihbalsoy/material-board/releases/),
* On your WordPress dashboard go to `Plugins` > `Add New`,
* Click the `Upload Plugin` button near the header,
* Select the downloaded zip archive,
* Finally, activate the Material Board plugin.

## Customization

Head over to `Appearance` > `Material Board` to customize the dashboard colors and looks.
Here are some of the available options:

* Theme (Light, Dark, and System)
* Colors (Primary and Accent colors)
* Toggle Rounded Corners
* Toggle Content Padding
* Font (DM Sans, Roboto, Mona, Hubot, or WordPress)
* Header Font (Serif or sans serif)
* Icons (Material or WordPress)
* Large App Bar (Bar or Menu on top)

## Languages

* English
* French (Français)
* German (Deutsch)
* Turkish (Türkçe)

## Known Issues

* Automatic system theme setting does not take effect until after two page refreshes.

## Setup & Build

Check out the [SETUP.md](SETUP.md) file to get started on setting up the developer environment and building the project.

## Contribution

Feel free to submit a pull request for one of the following:

* New features
* Language translation [(Crowdin Page)](https://crowdin.com/project/material-dashboard)
* Support third-party plugins or themes
* Fixing bugs and security vulnurabilities

## Licenses

Material Board, [AGPL License 3.0](https://github.com/fatihbalsoy/material-board/blob/master/LICENSE).

This project depends on the following third-parties:

* DM Sans Font, [SIL Open Font License 1.1](https://github.com/googlefonts/dm-fonts/blob/main/Serif/LICENSE.txt)
* DM Serif Font, [SIL Open Font License 1.1](https://github.com/googlefonts/dm-fonts/blob/main/Serif/LICENSE.txt)
* Mona Sans Font, [SIL Open Font License 1.1](https://github.com/github/mona-sans/blob/main/LICENSE)
* Hubot Sans Font, [SIL Open Font License 1.1](https://github.com/github/hubot-sans/blob/main/LICENSE)
* Roboto Font, [Apache License 2.0](https://github.com/googlefonts/roboto/blob/master/LICENSE).
* Official Material Design Icons, [Apache License 2.0](https://github.com/google/material-design-icons/blob/master/LICENSE).
* Community Material Design Icons, [SIL Open Font License 1.1](https://github.com/Templarian/MaterialDesign/blob/master/LICENSE).
* TinyColor, [MIT License](https://github.com/bgrins/TinyColor/blob/master/LICENSE).

