-
Notifications
You must be signed in to change notification settings - Fork 127
/
docusaurus.config.js
343 lines (338 loc) · 14.4 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
//@ts-check
import {themes as prismThemes} from "prism-react-renderer";
const path = require("path");
import {visit} from "unist-util-visit";
const FontPreloadPlugin = require("webpack-font-preload-plugin");
/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
title: "Keploy Documentation",
titleDelimiter: "🐰",
tagline: "API Test Generator Tool",
url: "https://keploy.io",
baseUrl: "/docs/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
trailingSlash: true,
favicon: "img/favicon.png",
organizationName: "keploy", // Usually your GitHub org/user name.
projectName: "docs", // Usually your repo name.
plugins: [
function preloadFontPlugin() {
return {
name: "preload-font-plugin",
configureWebpack() {
return {
plugins: [new FontPreloadPlugin()],
};
},
};
},
"docusaurus-tailwindcss-loader",
],
themeConfig: {
canonicalBase: "https://www.keploy.io/",
metadata: [
{
description: "Documentation for Keploy Backend Test Generator",
},
{
name: "x-default",
content: "en-us",
},
{
name: "description",
content:
"Keploy - Open source tool that generates Regression Tests like unit tests with mocks and stubs from API calls.",
},
{
name: "keywords",
content:
"API testing, Keploy docs, incident replay, network calls, code paths, test scenarios, code coverage, stubs, junit, go-test, live environment, production incidents, open source, regression tests, ai tests",
},
{name: "twitter:card", content: "summary_large_image"},
],
headTags: [
// Preconnect tag
{
tagName: "link",
attributes: {
rel: "preconnect",
href: "https://keploy.io/",
},
},
{
tagName: "script",
attributes: {
type: "application/ld+json",
},
innerHTML: JSON.stringify({
"@context": "https://schema.org/",
"@type": "Product",
description:
"Keploy - Open source tool that generates integration tests like unit tests with mocks or stubs from API calls.",
keywords:
"API testing, incident replay, network calls, code paths, test scenarios, code coverage, stubs, junit, go-test, live environment, production incidents, open source, regression tests, ai tests",
name: "Keploy",
url: "https://keploy.io/",
logo: "https://keploy.io/docs/img/favicon.png",
}),
},
],
colorMode: {
defaultMode: "light",
disableSwitch: false,
// switchConfig: {
// darkIcon: "🌙",
// darkIconStyle: {
// content: `url(/img/moon.svg)`,
// transform: "scale(2)",
// margin: "0 0.2rem",
// },
// lightIcon: "\u{1F602}",
// lightIconStyle: {
// content: `url(/img/sun.svg)`,
// transform: "scale(2)",
// },
// },
},
announcementBar: {
id: "announcementBar_1", // Increment on change
content: `⭐️ If you like Keploy, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/keploy/keploy">GitHub</a> and follow us on <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/keployio">Twitter</a> ❤️ `,
},
prism: {
theme: prismThemes.vsLight,
darkTheme: prismThemes.dracula,
additionalLanguages: ["java", "ruby", "php", "bash"],
},
// hideableSidebar: true,
navbar: {
hideOnScroll: false,
logo: {
alt: "Keploy logo",
src: "img/keploy-logo-dark.svg",
srcDark: "img/keploy-logo-dark.svg",
},
items: [
{
to: "/server/installation",
activeBasePath: "none",
label: "Installation",
},
// {
// to: "/server/installation/",
// label: "Installation",
// },
// {
// to: "/docs/operation/web-ui-operations/",
// activeBasePath: "(/docs/operation)",
// label: "Operations",
// },
// {
// to: "/docs/go/quickstart/run-your-first-app-tutorial/",
// activeBaseRegex:
// "(/application-development)|(/docs/(go|java|php|node))",
// label: "test SDKs",
// },
{
to: "/keploy-explained/contribution-guide",
label: "Contribution Guide",
},
{
to: "https://keploy.io/blog",
label: "Blog",
},
{
type: "docsVersionDropdown",
position: "right",
dropdownActiveClassDisabled: true,
},
{
href: "https://github.com/keploy/keploy",
position: "right",
className: "header-github-link",
"aria-label": "GitHub repository",
},
// TODO : Add Blogging Section
// {
// to: "/blog",
// activeBasePath: "/blog",
// label: "Blog",
// },
],
},
footer: {
copyright: `
<div className="footer__icons footer">
<a href="https://github.com/keploy/keploy" aria-label="GitHub"><svg class="footer__svg" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M12 0c-6.626 0-12 5.373-12 12 0 5.302 3.438 9.8 8.207 11.387.599.111.793-.261.793-.577v-2.234c-3.338.726-4.033-1.416-4.033-1.416-.546-1.387-1.333-1.756-1.333-1.756-1.089-.745.083-.729.083-.729 1.205.084 1.839 1.237 1.839 1.237 1.07 1.834 2.807 1.304 3.492.997.107-.775.418-1.305.762-1.604-2.665-.305-5.467-1.334-5.467-5.931 0-1.311.469-2.381 1.236-3.221-.124-.303-.535-1.524.117-3.176 0 0 1.008-.322 3.301 1.23.957-.266 1.983-.399 3.003-.404 1.02.005 2.047.138 3.006.404 2.291-1.552 3.297-1.23 3.297-1.23.653 1.653.242 2.874.118 3.176.77.84 1.235 1.911 1.235 3.221 0 4.609-2.807 5.624-5.479 5.921.43.372.823 1.102.823 2.222v3.293c0 .319.192.694.801.576 4.765-1.589 8.199-6.086 8.199-11.386 0-6.627-5.373-12-12-12z"/></svg></a>
<a href="https://twitter.com/keployio" aria-label="Twitter"><svg class="footer__svg" xmlns="http://www.w3.org/2000/svg" width="27px" height="24px" viewBox="0 0 24 24" version="1.1"><path d="M 20.476562 0.00390625 L 24.464844 0.00390625 L 15.753906 10.167969 L 26 23.996094 L 17.976562 23.996094 L 11.691406 15.609375 L 4.503906 23.996094 L 0.511719 23.996094 L 9.828125 13.125 L 0 0.00390625 L 8.226562 0.00390625 L 13.90625 7.671875 Z M 19.078125 21.558594 L 21.285156 21.558594 L 7.027344 2.3125 L 4.65625 2.3125 Z M 19.078125 21.558594 "/>
</g>
</svg></a>
<a href="https://www.youtube.com/channel/UC6OTg7F4o0WkmNtSoob34lg" aria-label="YouTube"><svg class="footer__svg" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M19.615 3.184c-3.604-.246-11.631-.245-15.23 0-3.897.266-4.356 2.62-4.385 8.816.029 6.185.484 8.549 4.385 8.816 3.6.245 11.626.246 15.23 0 3.897-.266 4.356-2.62 4.385-8.816-.029-6.185-.484-8.549-4.385-8.816zm-10.615 12.816v-8l8 3.993-8 4.007z"/></svg></a>
<a href="https://join.slack.com/t/keploy/shared_invite/zt-2poflru6f-_VAuvQfCBT8fDWv1WwSbkw" aria-label="Slack"><svg class="footer__svg" xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 2447.6 2452.5">
<path d="m897.4 0c-135.3.1-244.8 109.9-244.7 245.2-.1 135.3 109.5 245.1 244.8 245.2h244.8v-245.1c.1-135.3-109.5-245.1-244.9-245.3.1 0 .1 0 0 0m0 654h-652.6c-135.3.1-244.9 109.9-244.8 245.2-.2 135.3 109.4 245.1 244.7 245.3h652.7c135.3-.1 244.9-109.9 244.8-245.2.1-135.4-109.5-245.2-244.8-245.3z" /><path d="m2447.6 899.2c.1-135.3-109.5-245.1-244.8-245.2-135.3.1-244.9 109.9-244.8 245.2v245.3h244.8c135.3-.1 244.9-109.9 244.8-245.3zm-652.7 0v-654c.1-135.2-109.4-245-244.7-245.2-135.3.1-244.9 109.9-244.8 245.2v654c-.2 135.3 109.4 245.1 244.7 245.3 135.3-.1 244.9-109.9 244.8-245.3z" /><path d="m1550.1 2452.5c135.3-.1 244.9-109.9 244.8-245.2.1-135.3-109.5-245.1-244.8-245.2h-244.8v245.2c-.1 135.2 109.5 245 244.8 245.2zm0-654.1h652.7c135.3-.1 244.9-109.9 244.8-245.2.2-135.3-109.4-245.1-244.7-245.3h-652.7c-135.3.1-244.9 109.9-244.8 245.2-.1 135.4 109.4 245.2 244.7 245.3z" /><path d="m0 1553.2c-.1 135.3 109.5 245.1 244.8 245.2 135.3-.1 244.9-109.9 244.8-245.2v-245.2h-244.8c-135.3.1-244.9 109.9-244.8 245.2zm652.7 0v654c-.2 135.3 109.4 245.1 244.7 245.3 135.3-.1 244.9-109.9 244.8-245.2v-653.9c.2-135.3-109.4-245.1-244.7-245.3-135.4 0-244.9 109.8-244.8 245.1 0 0 0 .1 0 0"/>
</svg></a>
</div>
<div className="footer__icons footer">
<a class="footer__link-item" href="https://docs.google.com/forms/d/e/1FAIpQLSdj9q7dyRh3D7ZzRExHLWRRkNPOnLnFfrbKqSwqH3Ur4HzP4g/viewform">Have a Keploy use-case? Let's Talk!</a>
</div>
<div class="footer__copyright"><span class="footer__block">Copyright © ${new Date().getFullYear()}</span> Keploy Inc.</div>
<div>
<a class="footer__link-item" href="/about">About</a>
<span class="footer__separators"> | </span>
<a class="footer__link-item" href="/security">Security</a>
<span class="footer__separators"> | </span>
<a class="footer__link-item" href="/privacy-policy">Privacy Policy</a>
</div>
`,
},
algolia: {
apiKey: "c4628c331b0f4997178c879978033276",
indexName: "keploy",
appId: "WZTL8PLCOD",
contextualSearch: true, // Optional, If you different version of docs etc (v1 and v2) doesn't display dup results
// algoliaOptions: {}, // Optional, if provided by Algolia
},
},
presets: [
[
"@docusaurus/preset-classic",
{
// Will be passed to @docusaurus/plugin-content-docs
docs: {
sidebarPath: require.resolve("./sidebars.js"),
routeBasePath: "/",
exclude: ["**/shared/**"], // do not render "shared" content
editUrl: "https://github.com/keploy/docs/blob/master",
/**
* Whether to display the author who last updated the doc.
*/
showLastUpdateAuthor: false,
/**
* Whether to display the last date the doc was updated.
*/
showLastUpdateTime: false,
/**
* Skip the next release docs when versioning is enabled.
* This will not generate HTML files in the production build for documents
* in `/docs/next` directory, only versioned docs.
*/
// excludeNextVersionDocs: false,
lastVersion: "2.0.0",
versions: {
"1.0.0": {
label: "1.0.0",
path: "1.0.0",
banner: "unmaintained",
},
},
onlyIncludeVersions: ["1.0.0", "2.0.0"],
includeCurrentVersion: true, // excludeNextVersionDocs is now deprecated
// // below remark plugin disabled until we can figure out why it is not transpiling to ESNext properly - swyx
remarkPlugins: [
[
() =>
function addTSNoCheck(tree) {
// Disable TS type checking for any TypeScript code blocks.
// This is because imports are messy with snipsync: we don't
// have a way to pull in a separate config for every example
// snipsync pulls from.
function visitor(node) {
if (!/^ts$/.test(node.lang)) {
return;
}
node.value = "// @ts-nocheck\n" + node.value.trim();
}
visit(tree, "code", visitor);
},
{},
],
[
() =>
function removeTSNoCheck(tree) {
function visitor(node) {
if (!/^ts$/.test(node.lang) && !/^js$/.test(node.lang)) {
return;
}
if (node.value.startsWith("// @ts-nocheck\n")) {
node.value = node.value.slice("// @ts-nocheck\n".length);
}
// If TS compiled output is empty, replace it with a more helpful comment
if (
node.lang === "js" &&
node.value.trim() === "export {};"
) {
node.value = "// Not required in JavaScript";
} else if (node.lang === "js") {
node.value = convertIndent4ToIndent2(node.value).trim();
}
}
visit(tree, "code", visitor);
},
{},
],
],
},
// Will be passed to @docusaurus/plugin-content-blog
// options: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog
// TODO : Add Blogging Section
// blog: {
// routeBasePath: "blog",
// path: "blog",
// postsPerPage: 10,
// editUrl: "https://github.com/keploy/docs/blob/master",
// blogTitle: "Keploy Blog",
// showReadingTime: true, // Show estimated reading time for the blog post.
// feedOptions: {
// type: "all",
// copyright: `Copyright © ${new Date().getFullYear()} Keploy Inc. All rights reserved.`,
// },
// },
// Will be passed to @docusaurus/theme-classic.
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
gtag: {
trackingID: "G-LLS95VWZPC",
// Optional fields.
anonymizeIP: true, // Should IPs be anonymized?
},
// Will be passed to @docusaurus/plugin-content-sitemap
sitemap: {
// Per v2.0.0-alpha.72 cacheTime is now deprecated
//cacheTime: 600 * 1000, // 600 sec - cache purge period
changefreq: "weekly",
priority: 0.5,
},
},
],
],
scripts: [
{
src: "/docs/scripts/feedback.js",
async: true,
defer: true,
},
{
src: "/docs/scripts/clarity.js",
async: true,
defer: true,
},
{
src: "/docs/scripts/chat.js",
async: true,
defer: true,
},
// {
// src: "/scripts/fullstory.js",
// async: true,
// defer: true,
// },
],
};
function convertIndent4ToIndent2(code) {
// TypeScript always outputs 4 space indent. This is a workaround.
// See https://github.com/microsoft/TypeScript/issues/4042
return code.replace(/^( {4})+/gm, (match) => {
return " ".repeat(match.length / 4);
});
}