Files
pydantic/mkdocs.yml
T
Piotr Gnus abbad5e88c Added dark color scheme for docs (#2913)
* Added dark color scheme for docs

Added alternative, dark color scheme for docs, which should be automatically activated if user's browser presents the `prefers-color-scheme: dark` media query.

* switch icons

* add change file

Co-authored-by: PrettyWood <em.jolibois@gmail.com>
2021-09-04 20:37:42 +02:00

83 lines
1.8 KiB
YAML

site_name: pydantic
site_description: Data validation and settings management using python 3.6 type hinting
strict: true
site_url: https://pydantic-docs.helpmanual.io/
theme:
name: 'material'
custom_dir: 'docs/theme'
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: pink
accent: pink
toggle:
icon: material/lightbulb-outline
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: pink
accent: pink
toggle:
icon: material/lightbulb
name: "Switch to light mode"
logo: 'logo-white.svg'
favicon: 'favicon.png'
repo_name: samuelcolvin/pydantic
repo_url: https://github.com/samuelcolvin/pydantic
google_analytics:
- 'UA-62733018-4'
- 'auto'
extra_css:
- 'extra/terminal.css'
- 'extra/tweaks.css'
extra_javascript:
- 'extra/redirects.js'
- 'extra/ad.js'
nav:
- Overview: index.md
- install.md
- Usage:
- usage/models.md
- 'Field Types': usage/types.md
- usage/validators.md
- 'Model Config': usage/model_config.md
- usage/schema.md
- usage/exporting_models.md
- usage/dataclasses.md
- usage/validation_decorator.md
- 'Settings management': usage/settings.md
- usage/postponed_annotations.md
- 'Usage with mypy': usage/mypy.md
- 'Usage with devtools': usage/devtools.md
- Contributing to pydantic: contributing.md
- benchmarks.md
- 'Mypy plugin': mypy_plugin.md
- 'PyCharm plugin': pycharm_plugin.md
- 'Hypothesis plugin': hypothesis_plugin.md
- 'Code Generation': datamodel_code_generator.md
- changelog.md
markdown_extensions:
- markdown_include.include:
base_path: docs
- toc:
permalink: 🔗
- admonition
- pymdownx.highlight
- pymdownx.extra
- mdx_truly_sane_lists
plugins:
- search
- exclude:
glob:
- _build/*
- build/*
- examples/*
- requirements.txt