socketapi/mkdocs.yml at master · SpaceShaman/socketapi · 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
site_name: SocketAPI
site_url: https://spaceshaman.github.io/socketapi/
repo_url: https://github.com/SpaceShaman/socketapi
edit_uri: edit/master/docs/
repo_name: SpaceShaman/socketapi
site_description: SocketAPI is a lightweight Python framework for real-time WebSocket APIs, using a single multiplexed connection with endpoint-like actions and channel subscriptions.
site_author: SpaceShaman
copyright: The project is released under the MIT license.

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.ico
  icon:
    repo: fontawesome/brands/github
  features:
    - content.action.edit
    - content.action.view
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - navigation.footer
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/weather-night
        name: Switch to light mode

plugins:
  - git-revision-date-localized:
      type: timeago
  - git-committers:
      repository: SpaceShaman/socketapi
      branch: master
  - search
  - include-markdown
  - awesome-pages

markdown_extensions:
  - markdown.extensions.footnotes
  - markdown.extensions.attr_list
  - markdown.extensions.def_list
  - markdown.extensions.tables
  - markdown.extensions.abbr
  - markdown.extensions.md_in_html
  - pymdownx.superfences
  - pymdownx.betterem
  - pymdownx.details
  - pymdownx.tasklist
  - pymdownx.tabbed:
      alternate_style: true
  - admonition

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SpaceShaman/socketapi
      name: Repository
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/socketapi/
      name: PyPI package
    - icon: fontawesome/brands/readme
      link: https://github.com/SpaceShaman/socketapi?tab=MIT-1-ov-file
      name: License