forked from Consensys/doc.linea
-
Notifications
You must be signed in to change notification settings - Fork 0
/
docusaurus.config.js
350 lines (334 loc) · 9.88 KB
/
docusaurus.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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");
const math = require("remark-math");
const katex = require("rehype-katex");
// const isDev = process.env.NODE_ENV === "development";
// const baseUrl = isDev ? "/" : "/";
// const organizationName = "Consensys";
// const projectName = "doc.zk-evm";
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Linea",
tagline:
"An EVM-equivalent network, scaling the Ethereum experience. Secured with a zero-knowledge rollup to Ethereum, built on quantum-resistant, lattice-based cryptography, powered by Consensys.",
url: "https://docs.linea.build",
baseUrl: "/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
favicon: "img/favicon.ico",
trailingSlash: false,
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "Consensys", // Usually your GitHub org/user name.
projectName: "doc.zk-evm", // Usually your repo name.
deploymentBranch: "gh-pages", // Github Pages deploying branch
// Even if you don't use internalization, you can use this field to set useful
// metadata like html lang. For example, if your site is Chinese, you may want
// to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "en",
locales: ["en"],
},
presets: [
[
"classic",
{
docs: {
sidebarPath: require.resolve("./sidebars.js"),
// Set a base path separate from default /docs
editUrl: "https://github.com/Consensys/doc.zk-evm/tree/main/",
path: "docs",
routeBasePath: "/",
// @ts-ignore
// eslint-disable-next-line global-require
remarkPlugins: [require("remark-docusaurus-tabs")],
remarkPlugins: [math],
rehypePlugins: [katex],
include: ["**/*.md", "**/*.mdx"],
exclude: [
"**/_*.{js,jsx,ts,tsx,md,mdx}",
"**/_*/**",
"**/*.test.{js,jsx,ts,tsx}",
"**/__tests__/**",
],
showLastUpdateAuthor: true,
showLastUpdateTime: true,
includeCurrentVersion: true,
},
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
},
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
algolia: {
// The application ID provided by Algolia
appId: "NSRFPEJ4NC",
// Public API key: it is safe to commit it
apiKey: "cea41b975ad6c9a01408dfda6e0061d3",
indexName: "linea",
// Optional: see doc section below
contextualSearch: true,
// Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
externalUrlRegex: "external\\.com|domain\\.com",
// Optional: Algolia search parameters
searchParameters: {},
// Optional: path for search page that enabled by default (`false` to disable it)
searchPagePath: "search",
// ... other Algolia params
},
announcementBar: {
id: "announcement_bar",
content:
'📣Linea Mainnet Alpha is here! 🚀 Follow our User Guides <a href="https://docs.linea.build/use-mainnet">here</a> to get started 😎',
backgroundColor: "#fafbfc",
textColor: "#091E42",
isCloseable: false,
},
colorMode: {
defaultMode: "light",
disableSwitch: false,
respectPrefersColorScheme: true,
},
tableOfContents: {
minHeadingLevel: 2,
maxHeadingLevel: 5,
},
docs: {
sidebar: {
hideable: true,
autoCollapseCategories: true,
},
},
navbar: {
logo: {
alt: "Linea",
src: "img/logo.svg",
srcDark: "img/logo_dark.svg",
width: 55,
height: 55,
},
items: [
{
type: "docSidebar",
sidebarId: "docSidebar",
docId: "index",
position: "left",
label: "Docs",
},
{
type: "dropdown",
label: "Tutorials",
position: "left",
items: [
{
label: "Community Guides",
to: "blog",
},
{
label: "ZK Glossary",
to: "/zero-knowledge-glossary",
},
],
},
{
to: "https://support.linea.build/hc/",
position: "left",
label: "Support",
},
{
to: "https://linea.build/",
position: "left",
label: "Linea home",
},
{
href: "https://discord.gg/linea",
className: "header-discord-link",
position: "right",
},
{
href: "https://twitter.com/consensys",
className: "header-twitter-link",
position: "right",
},
],
},
footer: {
style: "dark",
links: [
{
title: "Learn",
items: [
{
label: "Use Linea",
to: "/use-mainnet",
},
{
label: "Build on Linea",
to: "/build-on-linea",
},
],
},
{
title: "Community",
items: [
{
label: "Join our Discord",
href: "https://discord.gg/linea",
},
{
label: "Get Help",
to: "https://support.linea.build/",
},
{
label: "Give Feedback",
to: "https://community.linea.build/c/feedback",
},
],
},
{
title: "Contribute",
items: [
{
label: "Contribute to our documentation",
href: "https://github.com/Consensys/doc.zk-evm",
},
{
label: "Contribute to our gnark repo",
href: "https://github.com/Consensys/gnark",
},
{
label: "Contribute to our gnark-crypto repo",
href: "https://github.com/Consensys/gnark-crypto",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Consensys, Inc.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ["solidity", "toml"],
},
languageTabs: [
{
highlight: "bash",
language: "curl",
logoClass: "bash",
},
{
highlight: "python",
language: "python",
logoClass: "python",
},
{
highlight: "go",
language: "go",
logoClass: "go",
},
{
highlight: "javascript",
language: "nodejs",
logoClass: "nodejs",
},
],
}),
plugins: [
[
"@docusaurus/plugin-google-gtag",
{
trackingID: "G-PY7JFNPXNH",
anonymizeIP: true,
},
],
[
"@docusaurus/plugin-google-tag-manager",
{
containerId: "GTM-TB58STH",
},
],
[
"@docusaurus/plugin-client-redirects",
{
redirects: [
{
to: "/architecture/bridges/message-service",
from: [
"/developers/bridge-architecture/message-service",
"/developers/use-message-bridge",
],
from: [
"/developers/bridge-architecture/message-service",
"/developers/use-message-bridge",
],
},
{
to: "/build-on-linea/quickstart",
from: [
"/developers/quickstart",
"/developers/deploy-smart-contracts",
],
},
{
to: "/zero-knowledge-glossary",
from: "/reference/glossary",
},
{
to: "/build-on-linea",
from: [
"/get-started",
"/get-started/fund",
"/get-started/configure-metamask",
"/get-started/quickstart",
"/use-zkevm",
"/use-linea/index.md",
],
},
{
to: "/use-mainnet/set-up-your-wallet",
from: "/build-on-linea/use-linea-testnet/set-up-your-wallet",
},
{
to: "/use-mainnet/fund",
from: "/build-on-linea/use-linea-testnet/fund",
},
{
to: "/use-mainnet/info-contracts",
from: "/build-on-linea/use-linea-testnet/info-contracts",
},
{
to: "/use-mainnet/explore/linea-voyage-faq",
from: "/use-linea-testnet/linea-voyage-faq",
},
{
to: "/build-on-linea/bridge-funds",
from: "/build-on-linea/use-linea-testnet/bridge-funds",
},
{
to: "/use-mainnet/bridges-of-linea",
from: "/build-on-linea/use-linea-testnet/bridge-funds/usdc-bridge",
},
{
to: "/use-mainnet/bridges-of-linea",
from: "/build-on-linea/use-linea-testnet/bridge-funds/use-etherscan",
},
],
},
],
],
stylesheets: [
{
href: "https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css",
type: "text/css",
integrity:
"sha384-odtC+0UGzzFL/6PNoE8rX/SPcQDXBJ+uRepguP4QkPCm2LBxH3FA3y+fKSiJ+AmM",
crossorigin: "anonymous",
},
],
themes: [],
};
module.exports = config;