mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2026-03-31 06:24:07 -04:00
78 lines
2.6 KiB
YAML
78 lines
2.6 KiB
YAML
# Copyright (c) 2016-2025 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.
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Configuration
|
|
# -----------------------------------------------------------------------------
|
|
|
|
# Definitions
|
|
definitions:
|
|
|
|
# Background image
|
|
- &background_image >-
|
|
{{ layout.background_image }}
|
|
|
|
# Page title with site name
|
|
- &page_title_with_site_name >-
|
|
{%- if not page.is_homepage -%}
|
|
{{ page.meta.get("title", page.title) }} - {{ config.site_name }}
|
|
{%- else -%}
|
|
{{ page.meta.get("title", page.title) }}
|
|
{%- endif -%}
|
|
|
|
# Page description
|
|
- &page_description >-
|
|
{%- if layout.description -%}
|
|
{{ layout.description }}
|
|
{%- else -%}
|
|
{{ page.meta.get("description", config.site_description) | x }}
|
|
{%- endif -%}
|
|
|
|
# Meta tags
|
|
tags:
|
|
|
|
# Open Graph
|
|
og:type: website
|
|
og:title: *page_title_with_site_name
|
|
og:description: *page_description
|
|
og:image: "{{ image.url }}"
|
|
og:image:type: "{{ image.type }}"
|
|
og:image:width: "{{ image.width }}"
|
|
og:image:height: "{{ image.height }}"
|
|
og:url: "{{ page.canonical_url }}"
|
|
|
|
# Twitter
|
|
twitter:card: summary_large_image
|
|
twitter:title: *page_title_with_site_name
|
|
twitter:description: *page_description
|
|
twitter:image: "{{ image.url }}"
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Specification
|
|
# -----------------------------------------------------------------------------
|
|
|
|
# Card size and layers
|
|
size: { width: 1200, height: 630 }
|
|
layers:
|
|
|
|
# Background
|
|
- background:
|
|
image: *background_image
|