forked from oxen-io/oxen-docs
-
Notifications
You must be signed in to change notification settings - Fork 1
/
mkdocs.yml
208 lines (184 loc) · 8.19 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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# Project information
site_name: 'Loki Docs'
site_url: 'https://docs.loki.network'
# Repository
repo_name: 'lokidocs'
repo_url: 'https://github.com/loki-project/loki-docs'
# Configuration
theme:
name: 'material'
language: 'en'
palette:
accent: 'green'
direction: 'ltr'
feature:
tabs: true
font: false
favicon: 'Loki_favicon32x32.png'
logo: 'logo.svg'
nav:
- 'Home': 'index.md'
- 'Introduction': 'Introduction/LokiNetwork.md'
- 'Getting Started': 'Introduction/GettingStarted.md'
- 'FAQ': 'FAQ.md'
- Wallets:
- 'Overview' : 'Wallets/WalletsOverview.md'
- 'Which wallet should I use?' : 'Wallets/WhatWalletToUse.md'
- Addresses:
- 'Main Address': 'Wallets/Addresses/MainAddress.md'
- 'Sub Address': 'Wallets/Addresses/SubAddress.md'
- 'Integrated Address': 'Wallets/Addresses/IntegratedAddress.md'
# - Web Wallet (LokiLocker):
# - 'Troubleshooting Web Wallet' : 'Wallets/WebWallet/TroubleshootWebWallet.md'
# - Guides:
# - 'to be added': 'Wallets/WebWallet/placeholder.md'
- 'Multsignature': 'Wallets/Multisignature.md'
- Guides:
- 'Electron Gui Setup': 'Wallets/GuiWallet/loki-electron-guide.md'
# - 'Gui Setup': 'Wallets/GuiWallet/loki-gui-guide.md'
- 'Gui Staking Guide': 'ServiceNodes/GUIStakingGuide.md'
- 'Mobile Wallet Restore': 'Wallets/MobileWallet/RestoreMobileWalletGuide.md'
- 'CLI Mac Setup': 'Wallets/CliWallet/loki-wallet-cliMacSetup.md'
- 'CLI Wallet Commands': 'Wallets/CliWallet/WalletCommands.md'
- 'CLI Restoring Wallet from Seed': 'Wallets/CliWallet/WalletRestoreSeed.md'
- 'CLI Restoring Wallet from Keys': 'Wallets/CliWallet/WalletRestoreKeys.md'
- Multisig:
- '2/2 Multisig': 'Wallets/CliWallet/2of2Multisig.md'
- '2/3 Multisig': 'Wallets/CliWallet/2of3Multisig.md'
- 'M/N Multsig': 'Wallets/CliWallet/MofNMultisig.md'
# Outdated, moved to POS
#- Mining:
# - 'Overview': 'Mining/MiningOverview.md'
# - 'ASIC Resistance': 'Mining/ASICResistance.md'
# - Guides:
# - 'XMR-Stak Mining': 'Mining/XMR-StakGuide.md'
# - 'XMR-Stak Linux Mining': 'Mining/XMR-Stak-Linux-Guide.md'
# - 'XMRig Mining': 'Mining/XMRig-Guide.md'
# - 'Mining With a SBC': 'Mining/Mining-With-SBC.md'
- Service Nodes:
- 'Overview': 'ServiceNodes/SNOverview.md'
# - 'Service Node Functions': 'ServiceNodes/ServiceNodeFunctions.md'
- 'Staking Requirement': 'ServiceNodes/StakingRequirement.md'
- 'Deregistration Rules': 'ServiceNodes/DeregistrationRules.md'
# - 'Infinite Staking Primer': 'ServiceNodes/InfiniteStakingPrimer.md'
- Guides:
# - 'Service Node Full Guide': 'ServiceNodes/SNFullGuide.md'
# - 'Legacy to Launcher Update Guide': 'ServiceNodes/UpdateGuide.md'
- 'Service Node Setup Guide': 'ServiceNodes/DebianPackageGuide.md'
- 'Loki-Launcher to Debian Update Guide': 'ServiceNodes/LauncherToDeb.md'
- 'Service Node RPC Guide': 'Developer/SNRPCGuide.md'
- 'Gui Staking Guide': 'ServiceNodes/GUIStakingGuide.md'
# - 'Launcher Config File': 'ServiceNodes/launcherconfig.md'
- 'Service Node Legacy Guide': 'ServiceNodes/SNFullGuideLegacy.md'
- 'Service Node TESTNET Guide': 'ServiceNodes/StorageServerGuide-Testnet.md'
- Troubleshooting:
- 'Port 22023 Not Open': 'ServiceNodes/OpenPort22023.md'
- Lokinet:
- 'Overview': 'Lokinet/LokinetOverview.md'
- 'Public Testing Overview': 'Lokinet/Guides/PublicTestingGuide.md'
- 'SNApps': 'Lokinet/SNApps.md'
- 'LLARP': 'Lokinet/LLARP.md'
# - 'Developers': 'Lokinet/DeveloperInfo.md'
- Guides:
- 'Linux GUI Guide': 'Lokinet/Guides/LokinetGuiGuide.md'
- 'macOS Gui Guide': 'Lokinet/Guides/lokinet-mac-guide.md'
- 'Exit Provider Guide': 'Lokinet/Guides/ExitProvider.md'
- 'Anonymous Reverse SSH Guide': 'Lokinet/Guides/ReverseSSHGuide.md'
- 'Linux Command-line Guide': 'Lokinet/Guides/lokinet-linux-guide.md'
# - 'Lokinet Windows Guide': 'Lokinet/Guides/lokinet-windows-guide.md'
- 'Linux - Build-It-Yourself': 'Lokinet/Guides/Install.md'
- 'Accessing SNApps': 'Lokinet/Guides/AccessingSNApps.md'
- 'Joining a Lokinet IRC Chat': 'Lokinet/Guides/LokinetIRC.md'
- 'Hosting SNApps': 'Lokinet/Guides/HostingSNApps.md'
# - 'Route through Exit Node': 'Lokinet/Guides/RouteThroughExitNode.md'
- 'Lokinet config files': 'Lokinet/Guides/LokinetConfig.md'
- 'Set up a Lokinet Router': 'Lokinet/Guides/LokinetRouter.md'
- 'Exit Nodes': 'Lokinet/Guides/ExitNode.md'
- Session:
- 'Overview': 'LokiServices/Messenger/Session.md'
- 'Loki Name System': 'LokiServices/Messenger/LokiNameSystem.md'
- 'Threat Models': 'LokiServices/Messenger/threat_model.md'
- 'Infrastructure': 'LokiServices/Messenger/infrastructure.md'
- 'Message Routing': 'LokiServices/Messenger/message_routing.md'
- 'Group Chats': 'LokiServices/Messenger/group_chats.md'
- 'Testing': 'LokiServices/Messenger/testing.md'
- 'Multi-Device': 'LokiServices/Messenger/multidevice.md'
- 'Client Side Protection': 'LokiServices/Messenger/client_side_protection.md'
- 'Attachments': 'LokiServices/Messenger/attachments.md'
- Guides:
- 'Register Session/Wallet names': 'LokiServices/Messenger/HowToRegisterSessionNames.md'
- 'Multi-Device Setup': 'LokiServices/Messenger/multi_device_setup.md'
- 'OpenGroup Setup': 'LokiServices/Messenger/opengroup_setup.md'
- 'Join Open Group on Mobile': 'LokiServices/Messenger/JoinOpenGroupMobile.md'
- 'Join Open Group on Desktop': 'LokiServices/Messenger/JoinOpenGroupDesktop.md'
- Blink:
- 'Blink': 'LokiServices/Blink.md'
- Checkpointing:
- 'Checkpointing LIP': 'Advanced/CheckpointingLip3.md'
- 'Safely Receiving Loki': 'Advanced/CheckpointingUpdate.md'
- Pulse:
- 'Advanced/PulseLip5.md'
- Advanced:
- Developer:
- 'Service Node RPC Guide': 'Developer/SNRPCGuide.md'
# - 'Daemon RPC Guide - Old': 'Developer/DaemonRPCGuide.md'
- 'Daemon RPC Guide - Beta': 'Developer/DaemonRPCBeta.md'
# - 'Wallet RPC Guide - Old': 'Developer/WalletRPCGuide.md'
- 'Wallet RPC Guide - Beta': 'Developer/WalletRPCBeta.md'
- 'Developer FAQ': 'Developer/FAQ.md'
- Loki Services:
- 'Overview': 'LokiServices/LokiServicesOverview.md'
- 'Blink': 'LokiServices/Blink.md'
- Attack Prevention:
- 'Denial of Service Attacks': 'Advanced/DenialofServiceAttacks.md'
- 'IP and Packet Blocking': 'Advanced/IPandPacketBlocking.md'
- 'Swarm Flagging': 'Advanced/SwarmFlagging.md'
- Contributing:
- 'How to Contribute to LokiDocs': 'Contributing/HowToContributeToLokiDocs.md'
- 'Vulnerability Response': 'Contributing/VULNERABILITY_RESPONSE_LOKI.md'
- 'Github Issue Template Example': 'Contributing/Issue_Template.md'
- Governance:
- 'Overview': 'Governance/Governance.md'
- 'The Loki Foundation': 'Governance/TheLokiFoundation.md'
- 'Loki Funding System': 'Governance/LokiFundingSystem.md'
- 'Cryptoeconomics' : 'Advanced/Cryptoeconomics.md'
- 'Sybil Resistance' : 'Advanced/SybilResistance.md'
- 'Dynamic Block Size': 'Advanced/DynamicBlockSize.md'
- 'CryptoNote Elements': 'Advanced/CryptoNoteElements.md'
- 'lokid' : 'Advanced/lokid.md'
- Guides:
# - 'Using Lokinet': 'Advanced/UsingLokinet.md'
- 'Using Tor': 'Advanced/UsingTor.md'
- 'Debugging': 'Advanced/Debugging.md'
- 'Accepting Loki for Merchants and Exchanges': 'Advanced/AcceptingLoki.md'
# Customization
extra_css:
- CSS/style.css
- CSS/font.css
extra_javascript:
- JAVASCRIPT/links.js
- JAVASCRIPT/style.js
extra:
social:
- type: 'github'
link: 'https://github.com/loki-project'
- type: 'twitter'
link: 'https://twitter.com/loki_project'
- type: 'telegram'
link: 'https://t.me/LokiCommunity'
- type: 'reddit'
link: 'https://www.reddit.com/r/LokiProject'
- type: 'youtube'
link: 'https://www.youtube.com/lokinetwork'
- type: 'facebook'
link: 'https://www.facebook.com/LokiNetwork/'
# Google Analytics
# nope
# Extensions
markdown_extensions:
- admonition
- meta
- codehilite:
guess_lang: false
- toc:
permalink: true