datamuse/mkdocs.yml at main · thetrotfreak/datamuse · 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
77
78
79
80
81
82
83
84
85
86
87
88
site_name: datamuse

site_author: thetrotfreak

repo_name: thetrotfreak/datamuse
repo_url: https://github.com/thetrotfreak/datamuse

theme:
  name: material
  # favicon: path/to/file.png
  icon:
    logo: material/language-python
    repo: material/git
  font:
    text: Noto Sans
    code: Noto Sans Mono
  palette:
    - media: "(prefers-color-scheme)"
      primary: light blue
      accent: light blue
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    - media: "(prefers-color-scheme: light)"
      primary: light blue
      accent: light blue
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      primary: light blue
      accent: light blue
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - header.autohide
    - navigation.footer
    - toc.integrate
    - content.code.copy

extra:
  generator: false
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  social:
    - icon: material/github
      link: https://github.com/thetrotfreak
      name: thetrotfreak on GitHub

plugins:
  # - optimize:
  - privacy:
  - search:
  - mkdocstrings:
      handlers:
        python:
          paths: [datamuse]
          options:
            docstring_style: sphinx
            show_source: false

markdown_extensions:
  - toc:
      anchorlink: true
      permalink: true
  - admonition:
  - pymdownx.details:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
  - pymdownx.inlinehilite:
  - pymdownx.snippets:

nav:
  - Get Started: index.md
  - Concepts: concepts.md
  - API Documentation: reference.md
  - Examples: examples.md