docs/mkdocs.yml at master · Hacker-Linner/docs · 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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# Project information
site_name: 'Colyseus 0.14'
site_description: 'Documentation for Colyseus Multiplayer Framework for Node.js'
site_author: 'Endel Dreyer'
site_url: 'https://colyseus.io/'
edit_uri: 'https://github.com/colyseus/docs/edit/master/docs/'

# Deployment
remote_name: 'origin'
remote_branch: 'gh-pages'

# Repository
repo_name: 'colyseus/colyseus'
repo_url: 'https://github.com/colyseus/colyseus'

# Copyright

copyright: 'Copyright &copy; 2021 Lucid Sight'
google_analytics: ['UA-108278048-3', 'docs.colyseus.io']

# Documentation and theme
theme:
  name: 'material'
  language: 'en'
  logo: 'images/logo-white.png'
  favicon: 'images/favicon.png'
  palette:
    primary: 'indigo'
    accent: 'indigo'
  font:
    text: 'Roboto'
    code: 'Roboto Mono'

extra_css:
  - 'stylesheets/code-tabs.css'
  - 'stylesheets/ads.css'

extra_javascript:
  - 'javascripts/main.js'
  - 'https://docs.colyseus.io/javascripts/previous_versions.js'
  # - 'javascripts/ads.js'

# Options
extra:
  search:
    language: 'en'
  social:
  - type: 'comments'
    link: 'https://discuss.colyseus.io'
  - type: 'globe'
    link: 'http://colyseus.io'
  - type: 'github'
    link: 'https://github.com/colyseus'
  - type: 'twitter'
    link: 'https://twitter.com/colyseus'

# Extensions
markdown_extensions:
  - admonition
  - codehilite:
      linenums: False
      guess_lang: False
  - toc:
      permalink: True
  - markdown_fenced_code_tabs:
      single_block_as_tab: False
      active_class: 'active'
      template: 'default'

# Nav menu
nav:
- 'Getting started': 'index.md'
- 'Client-side SDK':
  - 'Installation':
    - 'Unity': 'getting-started/unity3d-client.md'
    - 'JavaScript': 'getting-started/javascript-client.md'
    - 'Defold Engine': 'getting-started/defold-client.md'
    - 'Haxe': 'getting-started/haxe-client.md'
    - 'Cocos2d-x': 'getting-started/cocos2dx-client.md'
    - 'Construct3': 'getting-started/construct3-client.md'
  - 'API':
    - 'Client': 'client/client.md'
    - 'Room': 'client/room.md'

- 'Server API':
  - 'Server': 'server/api.md'
  - 'Room': 'server/room.md'
  - 'Client': 'server/client.md'
  - 'Timing events': 'server/timing-events.md'
  - 'Match-maker API': 'server/matchmaker.md'
  - 'Authentication API': 'server/authentication.md'
  - 'Presence': 'server/presence.md'
  - 'Graceful shutdown': 'server/graceful-shutdown.md'
  # - 'Custom State Serialization': 'server/state-serialization.md'

- 'State Handling':
  - 'Overview': 'state/overview.md'
  - 'Schema': 'state/schema.md'
  - 'Fossil Delta (deprecated)': 'state/fossil-delta.md'

- 'Built-in Rooms':
  - 'Lobby room': 'builtin-rooms/lobby.md'
  - 'Relay room': 'builtin-rooms/relay.md'

- 'Best practices':
  - 'Overview': 'best-practices/overview.md'
  - 'The Command Pattern': 'best-practices/command-pattern.md'

- "Tools":
  - "Monitoring Panel": 'tools/monitor.md'
  - "Load Testing": 'tools/loadtest.md'
  - "Authentication + Social": 'tools/colyseus-social.md'

- 'Debugging': 'debugging.md'
- 'Deployment': 'deployment.md'
- 'Scalability': 'scalability.md'

- "How-to":
  - 'Password-protect a room': 'how-to/password-protect-room.md'
  - 'Deny a player to join a room': 'how-to/deny-player-join-a-room.md'
  - 'Rate-limit': 'how-to/rate-limit.md'

- 'Migrating':
  - '0.14': 'migrating/0.14.md'
  - '0.13': 'migrating/0.13.md'
  - '0.12': 'migrating/0.12.md'
  - '0.11': 'migrating/0.11.md'
  - '0.10': 'migrating/0.10.md'
  - '0.9': 'migrating/0.9.md'

- "Tech Demos":
  - 'Shooting Gallery': 'demo/shooting-gallery/index.md'

- 'FAQ': 'faq.md'