python-mlb-statsapi/mkdocs.yml at main · zero-sum-seattle/python-mlb-statsapi · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
site_name: Python MLB Stats API
site_description: Unofficial Python client for MLB's Stats API with synchronous and asynchronous interfaces.
site_url: https://zero-sum-seattle.github.io/python-mlb-statsapi/
repo_url: https://github.com/zero-sum-seattle/python-mlb-statsapi
repo_name: zero-sum-seattle/python-mlb-statsapi
edit_uri: edit/main/docs/
copyright: Unofficial project. Not affiliated with Major League Baseball or any MLB team.

theme:
  name: material
  language: en
  features:
    - content.action.edit
    - content.action.view
    - content.code.copy
    - navigation.footer
    - navigation.instant
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.share
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: red
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: red
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Guides:
      - Usage Examples: examples.md
      - Stats Guide: stats.md
      - Async Usage: async.md
  - Reference:
      - Method Reference: methods.md
      - HTTP Transport: http-transport.md
      - Public API Contract: public-api.md
  - Release Notes:
      - Overview: releases.md
      - 1.1.0: releases/1.1.0.md
      - 1.0.1: releases/1.0.1.md
      - 1.0.0: releases/1.0.0.md
      - 0.9.0: releases/0.9.0.md
      - 0.8.0: releases/0.8.0.md
      - 0.7.1: releases/0.7.1.md

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn