mkdocs-material/material/mkdocs_theme.yml

# Copyright (c) 2016-2020 Martin Donath <martin.donath@squidfunk.com>

# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

# Language for theme localization
language: en

# Text direction (can be ltr or rtl), default: ltr
direction:

# Feature flags for functionality that alters behavior significantly, and thus
# may be a matter of taste
feature:

  # Another layer on top of the main navigation for larger screens in the form
  # of tabs, especially useful for larger documentation projects
  tabs: false

  # Instant loading will instruct the application to intercept all internal
  # links, load and inject the HTML into the page and rebind all handlers
  instant: false

# Sets the primary and accent color palettes as defined in the Material Design
# documentation - possible values can be looked up in the getting started guide
palette:

  # Primary color used for header, sidebar and links, default: indigo
  primary:

  # Accent color for highlighting user interaction, default: indigo
  accent:

# Fonts used by Material, automatically loaded from Google Fonts - see the site
# for a list of available fonts
font:

  # Default font for text
  text: Roboto

  # Fixed-width font for code listings
  code: Roboto Mono

# Favicon to be rendered
favicon: assets/images/favicon.png

# The logo of the documentation shown in the header and navigation can either
# be a Material Icon ligature (see https://material.io/icons/) or an image URL
logo:
  icon: "\uE80C"

# Material includes the search in the header as a partial, not as a separate
# template, so it's correct that search.html is missing
include_search_page: false

# Material doesn't use MkDocs search functionality but provides its own. For
# this reason, only the search index needs to be built
search_index_only: true

# Static pages to build
static_templates:
  - 404.html