Material Theme for MkDocs

Reference: here

Install

pip install mkdocs-material
theme: material

... or Use Local Files

git clone https://github.com/squidfunk/mkdocs-material.git
theme:
    name: null
    custom_dir: 'path/to/mkdocs-material/material'

Color Palette

Reference: here.

theme:
    name: 'material'
    palette:
        primary: 'green'
        accent: 'indigo'

Image

theme:
    logo: 'path/to/logo.png'

Material Icon

Reference: here

theme:
    logo:
        icon: 'stars'

Favicon

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.

theme:
    feature:
        tabs: true

Source Repository

repo_name: 'my-site'
repo_url: 'https://path/to/my/repo'
extra:
    social:
        - type: 'twitter'
          link: 'https://twitter.com/attiegrande'

Plugins

Reference: here