# Copyright (c) 2016-2022 Martin Donath # 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. # Project information site_name: Material for MkDocs site_url: https://squidfunk.github.io/mkdocs-material/ site_author: Martin Donath site_description: >- Create a branded static site from a set of Markdown files to host the documentation of your Open Source or commercial project # Repository repo_name: squidfunk/mkdocs-material repo_url: https://github.com/squidfunk/mkdocs-material # Copyright copyright: Copyright © 2016 - 2022 Martin Donath # Configuration theme: name: null custom_dir: !ENV [THEME_DIR, "material"] # Static files static_templates: - 404.html # Don't include MkDocs' JavaScript include_search_page: false search_index_only: true # Default values, taken from mkdocs_theme.yml language: en features: # - announce.dismiss - content.code.annotate # - content.tabs.link - content.tooltips # - header.autohide # - navigation.expand - navigation.indexes # - navigation.instant # - navigation.prune - navigation.sections - navigation.tabs # - navigation.tabs.sticky - navigation.top - navigation.tracking - search.highlight - search.share - search.suggest - toc.follow # - toc.integrate palette: - scheme: default primary: indigo accent: indigo toggle: icon: material/brightness-7 name: Switch to dark mode - scheme: slate primary: indigo accent: indigo toggle: icon: material/brightness-4 name: Switch to light mode font: text: Roboto code: Roboto Mono favicon: assets/favicon.png icon: logo: logo # Plugins plugins: - search - redirects: redirect_maps: changelog/insiders.md: insiders/changelog.md conventions.md: philosophy.md reference/abbreviations.md: reference/tooltips.md reference/meta-tags.md: reference/index.md reference/variables.md: https://mkdocs-macros-plugin.readthedocs.io/ sponsorship.md: insiders/index.md upgrading.md: upgrade.md - minify: minify_html: true # Customization extra: consent: title: Cookie consent description: >- We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better. analytics: provider: google property: UA-12345 #!ENV GOOGLE_ANALYTICS_KEY feedback: title: Was this page helpful? ratings: - icon: material/emoticon-happy-outline name: This page was helpful data: 1 note: >- Thanks for your feedback! - icon: material/emoticon-sad-outline name: This page could be improved data: 0 note: >- # ! Thanks for your feedback! Help us improve this page by using our feedback form. social: - icon: fontawesome/brands/github link: https://github.com/squidfunk - icon: fontawesome/brands/gitter link: https://gitter.im/squidfunk/mkdocs-material - icon: fontawesome/brands/docker link: https://hub.docker.com/r/squidfunk/mkdocs-material/ - icon: fontawesome/brands/python link: https://pypi.org/project/mkdocs-material/ - icon: fontawesome/brands/twitter link: https://twitter.com/squidfunk # Extensions markdown_extensions: - abbr - admonition - attr_list - def_list - footnotes - meta - md_in_html - toc: permalink: true - pymdownx.arithmatex: generic: true - pymdownx.betterem: smart_enable: all - pymdownx.caret - pymdownx.details - pymdownx.emoji: emoji_generator: !!python/name:materialx.emoji.to_svg emoji_index: !!python/name:materialx.emoji.twemoji - pymdownx.highlight: anchor_linenums: true - pymdownx.inlinehilite - pymdownx.keys - pymdownx.magiclink: repo_url_shorthand: true user: squidfunk repo: mkdocs-material - pymdownx.mark - pymdownx.smartsymbols - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: alternate_style: true - pymdownx.tasklist: custom_checkbox: true - pymdownx.tilde # Page tree nav: - Home: index.md - Getting started: - Installation: getting-started.md - Creating your site: creating-your-site.md - Publishing your site: publishing-your-site.md - Customization: customization.md - Browser support: browser-support.md - Philosophy: philosophy.md - Alternatives: alternatives.md - License: license.md - Changelog: - changelog/index.md - How to upgrade: upgrade.md - Setup: - Changing the colors: setup/changing-the-colors.md - Changing the fonts: setup/changing-the-fonts.md - Changing the language: setup/changing-the-language.md - Changing the logo and icons: setup/changing-the-logo-and-icons.md - Ensuring data privacy: setup/ensuring-data-privacy.md - Setting up navigation: setup/setting-up-navigation.md - Setting up site search: setup/setting-up-site-search.md - Setting up site analytics: setup/setting-up-site-analytics.md - Setting up social cards: setup/setting-up-social-cards.md - Setting up tags: setup/setting-up-tags.md - Setting up versioning: setup/setting-up-versioning.md - Setting up the header: setup/setting-up-the-header.md - Setting up the footer: setup/setting-up-the-footer.md - Adding a git repository: setup/adding-a-git-repository.md - Adding a comment system: setup/adding-a-comment-system.md - Building for offline usage: setup/building-for-offline-usage.md - Extensions: - setup/extensions/index.md - Python Markdown: setup/extensions/python-markdown.md - Python Markdown Extensions: setup/extensions/python-markdown-extensions.md - Reference: - reference/index.md - Admonitions: reference/admonitions.md - Annotations: reference/annotations.md - Buttons: reference/buttons.md - Code blocks: reference/code-blocks.md - Content tabs: reference/content-tabs.md - Data tables: reference/data-tables.md - Diagrams: reference/diagrams.md - Footnotes: reference/footnotes.md - Formatting: reference/formatting.md - Grids: reference/grids.md - Icons, Emojis: reference/icons-emojis.md - Images: reference/images.md - Lists: reference/lists.md - MathJax: reference/mathjax.md - Tooltips: reference/tooltips.md - Insiders: - insiders/index.md - Getting started: - Installation: insiders/getting-started.md - Changelog: insiders/changelog.md - Blog: - blog/index.md - 2022: - blog/2022/chinese-search-support.md - 2021: - blog/2021/the-past-present-and-future.md - blog/2021/excluding-content-from-search.md - blog/2021/search-better-faster-smaller.md