repod/mkdocs.yml at master · Walkercito/repod · 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: repod
site_url: https://walkercito.github.io/repod
site_description: Networking library for multiplayer games in Python
site_author: Walkercito

repo_name: Walkercito/repod
repo_url: https://github.com/Walkercito/repod

theme:
  name: material
  palette:
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - search.highlight
    - search.suggest
  logo: assets/logo.svg
  icon:
    repo: fontawesome/brands/github

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

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Walkercito/repod
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/repodnet/
  meta:
    - property: og:image
      content: https://walkercito.github.io/repod/assets/social-card.png
    - property: og:image:width
      content: "1200"
    - property: og:image:height
      content: "630"

nav:
  - Home: index.md
  - Get Started:
    - Installation: get-started/installation.md
    - How it works: get-started/how-it-works.md
  - Tutorial:
    - Building a server: tutorial/server.md
    - Building a client: tutorial/client.md
    - Putting it together: tutorial/together.md
    - Broadcasting: tutorial/broadcasting.md
    - Connections: tutorial/connections.md
    - Integrations: tutorial/pygame.md
    - Background server: tutorial/background-server.md
    - Type-safe generics: tutorial/generics.md
    - Async API: tutorial/async-api.md
  - API Reference:
    - Server: reference/server.md
    - Channel: reference/channel.md
    - ConnectionListener: reference/connection-listener.md
    - Client: reference/client.md
    - Protocol: reference/protocol.md
    - Constants: reference/constants.md
    - Logging: reference/logging.md
    - Wire format: reference/wire-format.md
  - Examples: examples.md