Material Theme for MkDocs

Reference: here

Install

pip install mkdocs-material

```yaml tab="mkdocs.yml" theme: material


### ... or Use Local Files

```bash
git clone https://github.com/squidfunk/mkdocs-material.git

```yaml tab="mkdocs.yml" theme: name: null custom_dir: 'path/to/mkdocs-material/material'


## Color Palette

Reference: [here](https://squidfunk.github.io/mkdocs-material/getting-started/#color-palette).

```yaml tab="mkdocs.yml"
theme:
    name: 'material'
    palette:
        primary: 'green'
        accent: 'indigo'

Image

```yaml tab="mkdocs.yml" theme: logo: 'path/to/logo.png'


### Material Icon

Reference: [here](https://material.io/resources/icons/?style=baseline)

```yaml tab="mkdocs.yml"
theme:
    logo:
        icon: 'stars'

Favicon

```yaml tab="mkdocs.yml" theme: favicon: 'path/to/favicon.ico'


## Tabs

The _top level only_ will me translated from vertical menu items to horizontal menu items under the heading.

```yaml tab="mkdocs.yml"
theme:
    feature:
        tabs: true

Source Repository

```yaml tab="mkdocs.yml" repo_name: 'my-site' repo_url: 'https://path/to/my/repo'


## Social Links

```yaml tab="mkdocs.yml"
extra:
    social:
        - type: 'twitter'
          link: 'https://twitter.com/attiegrande'

Plugins

Reference: here