forked from heroiclabs/nakama-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
134 lines (125 loc) · 4.62 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
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: 'Nakama server'
site_description: 'Documentation for the Nakama realtime and social server for games and apps.'
site_author: 'Heroic Labs Team & contributors'
site_url: 'https://heroiclabs.com/'
edit_uri: 'https://github.com/heroiclabs/nakama-docs/edit/master/docs/'
# Deployment
remote_name: 'origin'
remote_branch: 'gh-pages'
# Repository
repo_name: 'heroiclabs/nakama'
repo_url: 'https://github.com/heroiclabs/nakama'
# Copyright
copyright: 'Copyright © 2018 Heroic Labs'
# Documentation and theme
theme:
name: 'material'
language: 'en'
logo: 'images/logo-white.svg'
favicon: 'images/favicon.ico'
palette:
primary: 'indigo'
accent: 'indigo'
font:
text: 'Roboto'
code: 'Roboto Mono'
extra_css:
- 'stylesheets/code-tabs.css'
extra_javascript:
- 'javascripts/main.js'
# Options
extra:
search:
language: 'en'
social:
- type: 'globe'
link: 'https://heroiclabs.com'
- type: 'github'
link: 'https://github.com/heroiclabs'
- type: 'twitter'
link: 'https://twitter.com/heroicdev'
- type: 'linkedin'
link: 'https://www.linkedin.com/company/heroic-labs'
# Extensions
markdown_extensions:
- admonition
- codehilite:
linenums: False
guess_lang: False
- toc:
permalink: True
- markdown_fenced_code_tabs:
single_block_as_tab: False
# Nav menu
pages:
- 'Introduction': 'index.md'
- 'Download': 'nakama-download.md'
- 'Install and setup':
- 'Docker quickstart': 'install-docker-quickstart.md'
- 'Binary install': 'install-binary.md'
- 'Start server': 'install-start-server.md'
- 'Configuration': 'install-configuration.md'
- 'Nakama CLI': 'install-server-cli.md'
- 'Upgrades': 'install-nakama-upgrade.md'
- 'Unity client guide': 'unity-client-guide.md'
- 'JavaScript client guide': 'javascript-client-guide.md'
- 'Android client guide': 'android-java-client-guide.md'
- 'Swift/iOS client guide': 'swift-ios-client-guide.md'
#- 'Unreal engine': 'nakama-unreal-engine.md'
- 'Authentication': 'authentication.md'
- 'User accounts': 'user-accounts.md'
- 'Storage Engine':
- 'Collections': 'storage-collections.md'
- 'Access controls': 'storage-access-controls.md'
# - 'Design patterns': 'storage-design-patterns.md'
- 'Social':
- 'Friends': 'social-friends.md'
- 'Groups and Clans': 'social-groups-clans.md'
- 'In-app Notifications': 'social-in-app-notifications.md'
- 'Status': 'social-status.md'
- 'Realtime Chat': 'social-realtime-chat.md'
- 'Gameplay':
- 'Leaderboards': 'gameplay-leaderboards.md'
- 'Matchmaker': 'gameplay-matchmaker.md'
- 'Realtime Multiplayer': 'gameplay-multiplayer-realtime.md'
# - 'Turn-based Multiplayer': 'gameplay-multiplayer-turnbased.md'
# - 'In-app Purchase Validation': 'in-app-purchase-validation.md'
- 'Runtime Code':
- 'Basics': 'runtime-code-basics.md'
# - 'Best practices': 'runtime-code-best-practices.md'
# - 'Examples': 'runtime-code-examples.md'
# - 'Recommended modules': 'runtime-code-recommended-modules.md'
# - 'Lua for JavaScripters': 'runtime-lua-for-javascripters.md'
# - 'JavaScript/Lua comparison': 'runtime-javascript-lua-comparison.md'
# - 'Lua cheatsheet': 'runtime-lua-cheatsheet.md'
- 'Function Reference': 'runtime-code-function-reference.md'
#- 'Nakama enterprise': 'nakama-enterprise.md'
- 'Advanced':
- 'Streams': 'advanced-streams.md'
- 'Benchmarks': 'benchmarks.md'
- 'Deployment':
# - 'Production settings': 'deployment-production-settings.md'
# - 'Resource limits': 'deployment-resource-limits.md'
# - 'Managed Cloud': 'deployment-managed-cloud.md'
- 'Digital Ocean': 'deployment-digital-ocean.md'
- 'Tutorials':
# - 'Add custom roles to groups': 'tutorial-add-custom-roles-to-groups.md'
# - 'Authenticate with Game Center': 'tutorial-authenticate-with-game-center.md'
- 'Develop with LibGDX': 'tutorial-develop-with-libgdx.md'
- 'Initialize a new user': 'tutorial-initialize-new-user.md'
- 'Remote configuration': 'tutorial-remote-configuration.md'
- 'Send push messages': 'tutorial-send-push-messages.md'
# - 'Dynamic leaderboards': 'tutorial-dynamic-leaderboards.md'
# - 'Virtual wallet': 'tutorial-virtual-wallet.md'
# - 'Inventory management': 'tutorial-inventory-management.md'
# - 'Prized leaderboards': 'tutorial-prized-leaderboards.md'
#- 'Internals':
# - 'Server architecture': 'internal-nakama-server-architecture.md'
# - 'Social graph engine': 'internal-nakama-social-graph-engine.md'
# - 'Message router': 'internal-nakama-message-router.md'
# - 'Network protocol': 'internal-nakama-network-protocol.md'
# - 'Lua runtime': 'internal-nakama-lua-runtime.md'
#- 'Protocol reference': '#'
#- 'Release notes': '#'
- 'Previous versions': 'previous-versions.md'