forked from btcpayserver/btcpayserver-doc
-
Notifications
You must be signed in to change notification settings - Fork 2
/
config.js
303 lines (302 loc) · 9.21 KB
/
config.js
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
const { resolve } = require('path')
const implicitFigures = require('markdown-it-implicit-figures')
const slugify = require('./slugify')
const preprocessMarkdown = resolve(__dirname, 'preprocessMarkdown')
module.exports = {
title: "BTCPay Server Docs",
description: "BTCPay Server Official Documentation",
head: [
// Favicon
["link", { rel: "apple-touch-icon", href: "/apple-touch-icon.png", sizes: "180x180" }],
["link", { rel: "icon", type: "image/png", sizes: "32x32", href: "/favicon-32x32.png" }],
["link", { rel: "icon", type: "image/png", sizes: "16x16", href: "/favicon-16x16.png" }],
["link", { rel: "manifest", href: "/site.webmanifest" }],
["link", { rel: "mask-icon", href: "/safari-pinned-tab.svg", color: "#51b13e" }],
["meta", { name: "msapplication-TileColor", content: "#0f3b21" }],
["meta", { name: "theme-color", content: "#ffffff" }],
// Styles
["link", { rel: "stylesheet", href: "/styles/btcpayserver-variables.css" }]
],
chainWebpack (config) {
config.module
.rule('md')
.test(/\.md$/)
.use(preprocessMarkdown)
.loader(preprocessMarkdown)
.end()
},
plugins: [
['vuepress-plugin-clean-urls', {
normalSuffix: '/',
indexSuffix: '/',
notFoundPath: '/404.html',
}],
['vuepress-plugin-code-copy', {
color: '#8F979E',
backgroundTransition: false,
staticIcon: true
}],
['vuepress-plugin-medium-zoom', {
}]
],
markdown: {
extendMarkdown (md) {
md.use(implicitFigures)
},
slugify
},
themeConfig: {
logo: "/img/btcpay-logo.svg",
displayAllHeaders: false,
repo: "btcpayserver/btcpayserver-doc",
docsDir: "docs",
editLinks: true,
notSatisfiedLinks: true, // our own addition, see theme/components/PageEdit.vue
sidebarDepth: 0,
algolia: {
indexName: 'btcpayserver',
apiKey: '6a3a4c4380385cb5c9f9070247fdfca6',
// See https://www.algolia.com/doc/api-reference/api-parameters/
algoliaOptions: {
hitsPerPage: 10
},
// See https://community.algolia.com/docsearch/behavior.html#autocompleteoptions
autocompleteOptions: {
openOnFocus: true
}
},
nav: [
{
text: "Website",
link: "https://btcpayserver.org/"
},
{
text: "Chat",
link: "https://chat.btcpayserver.org/"
},
{
text: "GitHub",
link: "https://github.com/btcpayserver/",
rel: "noopener noreferrer github"
},
{
text: "Twitter",
link: "https://twitter.com/BtcpayServer",
rel: "noopener noreferrer twitter"
}
],
sidebar: [
["/", "Introduction"],
{
title: "Basics",
collapsable: false,
children: [
["/UseCase", "Use Case"],
["/Walkthrough", "Walkthrough"],
["/BTCPayVsOthers", "BTCPay Server vs. Others"],
["/TryItOut", "Try it out"]
]
},
{
title: "Deployment",
collapsable: false,
children: [
["/Deployment", "Choosing a Deployment Method"],
["/ThirdPartyHosting", "Third-party Hosting"],
{
title: "Docker",
path: "/Docker/",
collapsable: false,
children: [
// TODO: Add Configurator
{
title: "Web Deployment",
path: "/LunaNodeWebDeployment"
},
{
title: "Azure Deployment",
path: "/AzureDeployment",
children: [
["/AzurePennyPinching", "Reducing Cost on Azure"],
["/ChangeDomain", "Changing domain"]
]
},
{
title: "Google Cloud Deployment",
path: "/GoogleCloudDeployment"
},
{
title: "Hardware Deployment",
path: "/HardwareDeployment",
children: [
{
title: "Advanced Deployment",
collapsable: false,
children: [
["/DynamicDNS", "Dynamic DNS"],
["/ReverseSSHtunnel", "Reverse SSH Tunnel"]
]
},
{
title: "Hardware As A Service",
path: "/HardwareAsAService"
}
]
},
{
title: "Raspberry Pi Deployment",
path: "/RaspberryPiDeployment",
children: [
"/RPi3",
"/RPi4"
]
},
{
title: "Docker Plugins",
children: [
{
title: "Transmuter",
path: "/Transmuter/",
children: [
["/Transmuter/DCA", "Dollar Cost Average Preset"],
["/Transmuter/EmailReceiptsPreset", "Email Receipts Preset"]
]
},
["/ElectrumX", "Electrum X"],
["/ElectrumPersonalServer", "Electrum Personal Server"],
"/Docker/pihole"
]
}
]
},
{
title: "Manual Deployment",
path: "/ManualDeployment",
children: [
"/ManualDeploymentExtended"
]
}
]
},
{
title: "Getting Started",
collapsable: false,
children: [
"/RegisterAccount",
"/CreateStore",
{
title: "(3) Wallet Setup",
path: "/WalletSetup",
collapsable: false,
initialOpenGroupIndex: -1,
children: [
{
title: "Use existing hardware wallet",
path: "/Vault",
children: [
["/ColdCardWallet", "ColdCard Wallet"]
]
},
{
title: "Use existing software wallet",
children: [
{
title: "Electrum Wallet",
path: "/ElectrumWallet",
},
["/WasabiWallet", "Wasabi Wallet"]
]
},
{
title: "Create a new wallet",
path: "/CreateWallet",
children: [
["/HotWallet", "Hot Wallet"]
]
}
]
},
["/WhatsNext", "(4) What's Next?"]
]
},
{
title: "Features",
collapsable: false,
children: [
["/Apps", "Apps"],
["/Wallet", "Wallet"],
["/Invoices", "Invoices"],
{
title: "Pull Payments",
path: "/PullPayments",
children: [
["/Refund", "Refunds"]
]
},
["/PaymentRequests", "Payment Requests"],
["/LightningNetwork", "Lightning Network"],
["/Accounting", "Accounting"],
{
title: "Payjoin",
path: "/Payjoin",
children: [
["https://github.com/bitcoin/bips/blob/master/bip-0078.mediawiki", "Payjoin specification", { type: 'external' }]
]
}
]
},
{
title: "Integrations",
collapsable: false,
children: [
["/WooCommerce", "WooCommerce"],
["/Drupal", "Drupal"],
["/Magento", "Magento"],
["/PrestaShop", "PrestaShop"],
["/CustomIntegration", "Custom Integration"]
]
},
{
title: "Support and Community",
collapsable: false,
initialOpenGroupIndex: -1,
children: [
{
title: "FAQ and common issues",
path: "/FAQ",
children: [
["/FAQ/FAQ-General", "General FAQ"],
["/FAQ/FAQ-Deployment", "Deployment FAQ"],
["/FAQ/FAQ-Synchronization", "Synchronization FAQ"],
["/FAQ/FAQ-Integrations", "Integrations FAQ"],
["/FAQ/FAQ-ServerSettings", "Server Settings FAQ"],
["/FAQ/FAQ-Stores", "Stores FAQ"],
["/FAQ/FAQ-Wallet", "Wallet FAQ"],
["/FAQ/FAQ-Apps", "Apps FAQ"],
["/FAQ/FAQ-LightningNetwork", "Lightning Network FAQ"],
["/FAQ/FAQ-Altcoin", "Altcoins FAQ"]
]
},
["/Troubleshooting", "Troubleshooting an issue"],
["/Support", "Support"],
["/Contribute", "Contribute"],
["/Translate", "Translate"],
["/Community", "Community"]
]
},
{
title: "Development",
collapsable: false,
children: [
["/Architecture", "Architecture"],
["/LocalDevelopment", "Developing Locally"],
["/Altcoins", "How to add an Altcoin"],
["/Theme", "Customizing Themes"],
["https://docs.btcpayserver.org/API/Greenfield/v1", "Greenfield API v1", { type: 'external' }],
["/GreenFieldExample", "Greenfield example with cURL"],
["/BTCPayServer/Security", "Security Disclosures"],
]
}
]
}
}