Material Theme for MkDocs¶

Reference: here

Install¶

pip install mkdocs-material

mkdocs.yml

theme: material

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

mkdocs.yml

theme:
    name: null
    custom_dir: 'path/to/mkdocs-material/material'

Reference: here.

mkdocs.yml

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

mkdocs.yml

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

Reference: here

mkdocs.yml

theme:
    logo:
        icon: 'stars'

mkdocs.yml

theme:
    favicon: 'path/to/favicon.ico'

The top level only will me translated from vertical menu items to horizontal menu items under the heading.

mkdocs.yml

theme:
    feature:
        tabs: true

mkdocs.yml

repo_name: 'my-site'
repo_url: 'https://path/to/my/repo'

mkdocs.yml

extra:
    social:
        - type: 'twitter'
          link: 'https://twitter.com/attiegrande'

Reference: here