128 lines
3.6 KiB
YAML
128 lines
3.6 KiB
YAML
|
# Copyright (c) 2016-2019 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.
|
||
|
|
|
||
|
|
# Project information
|
||
|
|
site_name: Material for MkDocs
|
||
|
|
site_description: A Material Design theme for MkDocs
|
||
|
|
site_author: Martin Donath
|
||
|
|
site_url: https://squidfunk.github.io/mkdocs-material/
|
||
|
|
|
||
|
|
# Repository
|
||
|
|
repo_name: squidfunk/mkdocs-material
|
||
|
|
repo_url: https://github.com/squidfunk/mkdocs-material
|
||
|
|
edit_uri: ""
|
||
|
|
|
||
|
|
# Copyright
|
||
|
|
copyright: 'Copyright © 2016 - 2019 Martin Donath'
|
||
|
|
|
||
|
|
# Configuration
|
||
|
|
theme:
|
||
|
|
name: null
|
||
|
|
custom_dir: material
|
||
|
|
|
||
|
|
# 404 page
|
||
|
|
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
|
||
|
|
feature:
|
||
|
|
tabs: true
|
||
|
|
palette:
|
||
|
|
primary: indigo
|
||
|
|
accent: indigo
|
||
|
|
font:
|
||
|
|
text: Roboto
|
||
|
|
code: Roboto Mono
|
||
|
|
favicon: assets/images/favicon.png
|
||
|
|
logo:
|
||
|
|
icon: "\uE80C"
|
||
|
|
|
||
|
|
# Customization
|
||
|
|
extra:
|
||
|
|
social:
|
||
|
|
- type: globe
|
||
|
|
link: http://struct.cc
|
||
|
|
- type: github-alt
|
||
|
|
link: https://github.com/squidfunk
|
||
|
|
- type: twitter
|
||
|
|
link: https://twitter.com/squidfunk
|
||
|
|
- type: linkedin
|
||
|
|
link: https://linkedin.com/in/squidfunk
|
||
|
|
|
||
|
|
# Extensions
|
||
|
|
markdown_extensions:
|
||
|
|
- markdown.extensions.admonition
|
||
|
|
- markdown.extensions.codehilite:
|
||
|
|
guess_lang: false
|
||
|
|
- markdown.extensions.def_list
|
||
|
|
- markdown.extensions.footnotes
|
||
|
|
- markdown.extensions.meta
|
||
|
|
- markdown.extensions.toc:
|
||
|
|
permalink: true
|
||
|
|
- pymdownx.arithmatex
|
||
|
|
- pymdownx.betterem:
|
||
|
|
smart_enable: all
|
||
|
|
- pymdownx.caret
|
||
|
|
- pymdownx.critic
|
||
|
|
- pymdownx.details
|
||
|
|
- pymdownx.emoji:
|
||
|
|
emoji_generator: !!python/name:pymdownx.emoji.to_svg
|
||
|
|
- pymdownx.inlinehilite
|
||
|
|
- pymdownx.keys
|
||
|
|
- pymdownx.magiclink:
|
||
|
|
repo_url_shorthand: true
|
||
|
|
user: squidfunk
|
||
|
|
repo: mkdocs-material
|
||
|
|
- pymdownx.mark
|
||
|
|
- pymdownx.smartsymbols
|
||
|
|
- pymdownx.superfences
|
||
|
|
- pymdownx.tasklist:
|
||
|
|
custom_checkbox: true
|
||
|
|
- pymdownx.tilde
|
||
|
|
|
||
|
|
# Page tree
|
||
|
|
nav:
|
||
|
|
- Material: index.md
|
||
|
|
- Getting started: getting-started.md
|
||
|
|
- Extensions:
|
||
|
|
- Admonition: extensions/admonition.md
|
||
|
|
- CodeHilite: extensions/codehilite.md
|
||
|
|
- Footnotes: extensions/footnotes.md
|
||
|
|
- Metadata: extensions/metadata.md
|
||
|
|
- Permalinks: extensions/permalinks.md
|
||
|
|
- PyMdown: extensions/pymdown.md
|
||
|
|
- Specimen: specimen.md
|
||
|
|
- Customization: customization.md
|
||
|
|
- Compliance with GDPR: compliance.md
|
||
|
|
- Release notes: release-notes.md
|
||
|
|
- Author's notes: authors-notes.md
|
||
|
|
- Contributing: contributing.md
|
||
|
|
- License: license.md
|
||
|
|
|
||
|
|
# Google Analytics
|
||
|
|
google_analytics:
|
||
|
|
- !!python/object/apply:os.getenv ["GOOGLE_ANALYTICS_KEY"]
|
||
|
|
- auto
|