forked from colyseus/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
100 lines (86 loc) · 2.28 KB
/
mkdocs.yml
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
# Project information
site_name: 'Colyseus v0.9.x'
site_description: 'Documentation for Colyseus Multiplayer Game Server for Node.js'
site_author: 'gamestd.io'
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: 'gamestdio/colyseus'
repo_url: 'https://github.com/gamestdio/colyseus'
# Copyright
copyright: 'Copyright © 2018 Endel Dreyer'
# Documentation and theme
theme:
name: 'material'
language: 'en'
logo: 'images/logo-white.png'
favicon: 'images/favicon.png'
custom_dir: 'theme'
palette:
primary: 'indigo'
accent: 'indigo'
font:
text: 'Roboto'
code: 'Roboto Mono'
extra_css:
- 'stylesheets/code-tabs.css'
extra_javascript:
- 'javascripts/main.js'
- 'javascripts/codefund.js'
# Options
extra:
search:
language: 'en'
social:
- type: 'money'
link: 'https://www.patreon.com/endel'
- type: 'comments'
link: 'https://discuss.colyseus.io'
- type: 'globe'
link: 'http://colyseus.io'
- type: 'github'
link: 'https://github.com/gamestdio'
- type: 'twitter'
link: 'https://twitter.com/gstdio'
- type: 'linkedin'
link: 'https://www.linkedin.com/company/game-std-io/'
# Extensions
markdown_extensions:
- admonition
- codehilite:
linenums: False
guess_lang: False
- toc:
permalink: True
- markdown_fenced_code_tabs:
single_block_as_tab: False
- del_ins
# Nav menu
pages:
- 'Introduction': 'index.md'
- 'Getting started': 'getting-started.md'
- 'Concepts':
- 'State synchronization': 'concept-state-synchronization.md'
- 'Matchmaking': 'concept-matchmaking.md'
- 'Server-side':
- 'Server': 'api-server.md'
- 'Room': 'api-room.md'
- 'Client': 'api-client.md'
- 'Timing events': 'api-timing-events.md'
- 'State management': 'api-room-state.md'
- 'Authentication': 'api-authentication.md'
- 'Presence': 'api-presence.md'
- 'Graceful shutdown': 'api-graceful-shutdown.md'
- 'Debugging': 'api-debugging.md'
- 'Client-side':
- 'Overview': 'client-overview.md'
- 'Room': 'client-room.md'
- 'State synchronization': 'client-state-synchronization.md'
- 'Deployment': 'deployment.md'
- 'Migrating': 'migrating.md'
- 'FAQ': 'faq.md'
- 'More':
- 'Roadmap': 'roadmap.md'