Browse Source

🔧 Clean up `docs/en/mkdocs.yml` configuration file (#13542)

pull/13548/head
Sofie Van Landeghem 1 week ago
committed by GitHub
parent
commit
031622a989
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 76
      docs/en/mkdocs.yml

76
docs/en/mkdocs.yml

@ -6,7 +6,7 @@ theme:
name: material name: material
custom_dir: ../en/overrides custom_dir: ../en/overrides
palette: palette:
- media: "(prefers-color-scheme)" - media: (prefers-color-scheme)
toggle: toggle:
icon: material/lightbulb-auto icon: material/lightbulb-auto
name: Switch to light mode name: Switch to light mode
@ -27,7 +27,6 @@ theme:
features: features:
- content.code.annotate - content.code.annotate
- content.code.copy - content.code.copy
# - content.code.select
- content.footnote.tooltips - content.footnote.tooltips
- content.tabs.link - content.tabs.link
- content.tooltips - content.tooltips
@ -35,7 +34,6 @@ theme:
- navigation.indexes - navigation.indexes
- navigation.instant - navigation.instant
- navigation.instant.prefetch - navigation.instant.prefetch
# - navigation.instant.preview
- navigation.instant.progress - navigation.instant.progress
- navigation.path - navigation.path
- navigation.tabs - navigation.tabs
@ -46,7 +44,6 @@ theme:
- search.share - search.share
- search.suggest - search.suggest
- toc.follow - toc.follow
icon: icon:
repo: fontawesome/brands/github-alt repo: fontawesome/brands/github-alt
logo: img/icon-white.svg logo: img/icon-white.svg
@ -55,11 +52,7 @@ theme:
repo_name: fastapi/fastapi repo_name: fastapi/fastapi
repo_url: https://github.com/fastapi/fastapi repo_url: https://github.com/fastapi/fastapi
plugins: plugins:
# Material for MkDocs search: null
search:
# Configured in mkdocs.insiders.yml
# social:
# Other plugins
macros: macros:
include_yaml: include_yaml:
- external_links: ../en/data/external_links.yml - external_links: ../en/data/external_links.yml
@ -103,7 +96,6 @@ plugins:
signature_crossrefs: true signature_crossrefs: true
show_symbol_type_heading: true show_symbol_type_heading: true
show_symbol_type_toc: true show_symbol_type_toc: true
nav: nav:
- FastAPI: index.md - FastAPI: index.md
- features.md - features.md
@ -258,33 +250,27 @@ nav:
- benchmarks.md - benchmarks.md
- management.md - management.md
- release-notes.md - release-notes.md
markdown_extensions: markdown_extensions:
# Python Markdown abbr: null
abbr: attr_list: null
attr_list: footnotes: null
footnotes: md_in_html: null
md_in_html: tables: null
tables:
toc: toc:
permalink: true permalink: true
pymdownx.betterem: null
# Python Markdown Extensions pymdownx.caret: null
pymdownx.betterem:
pymdownx.caret:
pymdownx.highlight: pymdownx.highlight:
line_spans: __span line_spans: __span
pymdownx.inlinehilite: pymdownx.inlinehilite: null
pymdownx.keys: pymdownx.keys: null
pymdownx.mark: pymdownx.mark: null
pymdownx.superfences: pymdownx.superfences:
custom_fences: custom_fences:
- name: mermaid - name: mermaid
class: mermaid class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format format: !!python/name:pymdownx.superfences.fence_code_format ''
pymdownx.tilde: pymdownx.tilde: null
# pymdownx blocks
pymdownx.blocks.admonition: pymdownx.blocks.admonition:
types: types:
- note - note
@ -295,17 +281,13 @@ markdown_extensions:
- tip - tip
- hint - hint
- warning - warning
# Custom types
- info - info
- check - check
pymdownx.blocks.details: pymdownx.blocks.details: null
pymdownx.blocks.tab: pymdownx.blocks.tab:
alternate_style: True alternate_style: true
mdx_include: null
# Other extensions markdown_include_variants: null
mdx_include:
markdown_include_variants:
extra: extra:
analytics: analytics:
provider: google provider: google
@ -313,16 +295,14 @@ extra:
feedback: feedback:
title: Was this page helpful? title: Was this page helpful?
ratings: ratings:
- icon: material/emoticon-happy-outline - icon: material/emoticon-happy-outline
name: This page was helpful name: This page was helpful
data: 1 data: 1
note: >- note: Thanks for your feedback!
Thanks for your feedback! - icon: material/emoticon-sad-outline
- icon: material/emoticon-sad-outline name: This page could be improved
name: This page could be improved data: 0
data: 0 note: Thanks for your feedback!
note: >-
Thanks for your feedback!
social: social:
- icon: fontawesome/brands/github-alt - icon: fontawesome/brands/github-alt
link: https://github.com/fastapi/fastapi link: https://github.com/fastapi/fastapi
@ -338,7 +318,6 @@ extra:
link: https://medium.com/@tiangolo link: https://medium.com/@tiangolo
- icon: fontawesome/solid/globe - icon: fontawesome/solid/globe
link: https://tiangolo.com link: https://tiangolo.com
alternate: alternate:
- link: / - link: /
name: en - English name: en - English
@ -390,14 +369,11 @@ extra:
name: zh-hant - 繁體中文 name: zh-hant - 繁體中文
- link: /em/ - link: /em/
name: 😉 name: 😉
extra_css: extra_css:
- css/termynal.css - css/termynal.css
- css/custom.css - css/custom.css
extra_javascript: extra_javascript:
- js/termynal.js - js/termynal.js
- js/custom.js - js/custom.js
hooks: hooks:
- ../../scripts/mkdocs_hooks.py - ../../scripts/mkdocs_hooks.py

Loading…
Cancel
Save