Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 13 additions & 17 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
//@ts-check
// @ts-nocheck

import {themes as prismThemes} from "prism-react-renderer";
const path = require("path");
import {visit} from "unist-util-visit";
const { themes: prismThemes } = require("prism-react-renderer");
const visit = require("unist-util-visit");
const FontPreloadPlugin = require("webpack-font-preload-plugin");

/** @type {import('@docusaurus/types').DocusaurusConfig} */
Expand Down Expand Up @@ -50,7 +49,7 @@ module.exports = {
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"},
{ name: "twitter:card", content: "summary_large_image" },
],
headTags: [
// Preconnect tag
Expand Down Expand Up @@ -259,7 +258,8 @@ module.exports = {
* in `/docs/next` directory, only versioned docs.
*/
// excludeNextVersionDocs: false,
lastVersion: "4.0.0",
// Previous v3.0.0 archived in versioned_docs/version-3.0.0-archive
lastVersion: "3.0.0",
versions: {
"1.0.0": {
label: "1.0.0",
Expand All @@ -271,13 +271,8 @@ module.exports = {
path: "2.0.0",
banner: "unmaintained",
},
"3.0.0": {
label: "3.0.0",
path: "3.0.0",
banner: "unmaintained",
},
},
onlyIncludeVersions: ["1.0.0", "2.0.0", "3.0.0", "4.0.0"],
onlyIncludeVersions: ["1.0.0", "2.0.0", "3.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: [
Expand Down Expand Up @@ -343,11 +338,12 @@ module.exports = {
theme: {
customCss: require.resolve("./src/css/custom.css"),
},
gtag: {
trackingID: "G-LLS95VWZPC",
// Optional fields.
anonymizeIP: true, // Should IPs be anonymized?
},
// Temporarily disabled gtag due to "window.gtag is not a function" error
// 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
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
"react-player": "^2.6.0",
"remark-typescript-tools": "1.0.9",
"typescript": "5",
"unist-util-visit": "^2.0.3",
"uuid": "^8.3.2",
"webpack-font-preload-plugin": "^1.5.0"
},
Expand Down
33 changes: 33 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/**
* Creating a sidebar enables you to:
- create an ordered group of docs
- render a sidebar for each doc of that group
- provide next/previous navigation

The sidebars can be generated from the filesystem, or explicitly defined here.

Create as many sidebars as you want.
*/

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
// tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],

// But you can create a sidebar manually
/*
tutorialSidebar: [
'intro',
'hello',
{
type: 'category',
label: 'Tutorial',
items: ['tutorial-basics/create-a-document'],
},
],
*/
};

module.exports = sidebars;
205 changes: 205 additions & 0 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -2721,3 +2721,208 @@ html[data-theme="dark"] div[class^="sidebar_"] > nav > ul > li > .menu__list-ite
line-height: 1.4;
}
}

/* ===== CONSISTENT SPACING FOR DOCUMENTATION PAGES ===== */
/* Fix inconsistent vertical spacing in documentation content */
article header + * {
margin-top: 2rem !important; /* Consistent space after page title */
}

article h1 {
margin-bottom: 1.5rem !important; /* Consistent space after H1 */
}

article h2 {
margin-top: 2.5rem !important; /* Consistent space before H2 */
margin-bottom: 1rem !important; /* Consistent space after H2 */
}

article h3 {
margin-top: 2rem !important; /* Consistent space before H3 */
margin-bottom: 0.75rem !important; /* Consistent space after H3 */
}

article p {
margin-bottom: 1rem !important; /* Consistent space after paragraphs */
}

article img {
margin-top: 1.5rem !important; /* Consistent space before images */
margin-bottom: 1.5rem !important; /* Consistent space after images */
}

article \u003e div[style*='backgroundColor'] {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CRITICAL: Invalid CSS selector - \u003e should be >

The literal string \u003e is being used instead of the > (child combinator) character. This CSS selector will not work as intended.

Suggested change
article \u003e div[style*='backgroundColor'] {
article > div[style*='backgroundColor'] {

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image resolved this

margin-top: 1.5rem !important; /* Consistent space before styled divs */
margin-bottom: 1.5rem !important; /* Consistent space after styled divs */
}


/* Override Tailwind prose spacing for better consistency */
.prose.md\\:prose-md {
margin-top: 1.5rem !important;
margin-bottom: 1.5rem !important;
}

/* More specific overrides for prose elements */
.prose p {
margin-top: 1rem !important;
margin-bottom: 1rem !important;
}

.prose h1 {
margin-top: 0 !important;
margin-bottom: 1.5rem !important;
}

.prose h2 {
margin-top: 2rem !important;
margin-bottom: 1rem !important;
}

.prose h3 {
margin-top: 1.5rem !important;
margin-bottom: 0.75rem !important;
}

.prose img {
margin-top: 1.5rem !important;
margin-bottom: 1.5rem !important;
}

/* Fix the large top margin on first element after header */
.markdown \u003e *:first-child,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CRITICAL: Invalid CSS selector - \u003e should be >

Same issue as above - the literal string \u003e should be replaced with the > character.

Suggested change
.markdown \u003e *:first-child,
.markdown > *:first-child,

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image resolved this

article \u003e .markdown \u003e *:first-child {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CRITICAL: Invalid CSS selector - \u003e should be >

Multiple occurrences of \u003e that should be > characters.

Suggested change
article \u003e .markdown \u003e *:first-child {
article > .markdown > *:first-child {

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image resolved this

margin-top: 1.5rem !important;
}


/* Fix clipped descenders in headings (y, g, p, q, j) */
article h1,
.prose h1 {
line-height: 1.3 !important; /* Increase line-height to prevent clipping */
padding-bottom: 0.2rem !important; /* Add padding to ensure descenders are visible */
overflow: visible !important; /* Ensure text isn't clipped */
}

article h2,
.prose h2 {
line-height: 1.4 !important;
padding-bottom: 0.15rem !important;
overflow: visible !important;
}

article h3,
.prose h3 {
line-height: 1.4 !important;
padding-bottom: 0.1rem !important;
overflow: visible !important;
}


/* Reduce excessive spacing - fine-tuned values */
article h1,
.prose h1 {
margin-bottom: 1rem !important; /* Reduced from 1.5rem */
}

/* Reduce top margin on first paragraph after title */
article h1 + p,
.prose h1 + p {
margin-top: 1rem !important; /* Consistent spacing after H1 */
}

/* Adjust H2 spacing to be less aggressive */
article h2,
.prose h2 {
margin-top: 1.75rem !important; /* Reduced from 2rem */
margin-bottom: 0.75rem !important; /* Reduced from 1rem */
}

/* Adjust paragraph spacing */
article p,
.prose p {
margin-top: 0.75rem !important; /* Reduced */
margin-bottom: 0.75rem !important; /* Reduced */
}

/* Adjust image spacing */
article img,
.prose img {
margin-top: 1.25rem !important; /* Reduced from 1.5rem */
margin-bottom: 1.25rem !important; /* Reduced from 1.5rem */
}


/* Reduce top padding/margin above page title across all docs pages */
article,
.markdown,
[class*='docItemContainer'] article {
padding-top: 1rem !important; /* Reduced top padding */
}

/* Reduce margin-top on the H1 title itself */
article h1:first-of-type,
.prose h1:first-of-type,
.markdown h1:first-of-type {
margin-top: 0.5rem !important; /* Minimal top margin for first H1 */
}

/* Remove excessive top margin from article header */
article header {
margin-top: 0 !important;
padding-top: 0 !important;
}

/* Reduce top margin on first element after breadcrumbs */
.theme-doc-breadcrumbs + * {
margin-top: 1rem !important;
}


/* OVERRIDE: Reduce top margin/padding on markdown container - more specific selectors */
div.theme-doc-markdown.markdown,
.theme-doc-markdown,
[class*='theme-doc-markdown'] {
margin-top: 0 !important;
padding-top: 0.5rem !important; /* Minimal top padding */
}

/* Target the prose container specifically */
.prose.md\\:prose-md.prose-auto.my-12 {
margin-top: 1rem !important; /* Override my-12 class */
margin-bottom: 1rem !important;
}

/* Remove large top margin from article/main content */
main article,
[class*='docItemContainer'] {
margin-top: 0 !important;
padding-top: 0.5rem !important;
}


/* EQUAL SPACING: Make top and bottom spacing around H1 consistent */
/* This creates better visual balance for documentation pages */

/* Set consistent spacing after breadcrumbs */
nav.theme-doc-breadcrumbs {
margin-bottom: 1.5rem !important; /* Equal to H1 bottom margin */
}

/* Ensure H1 has equal spacing on both sides */
article h1:first-of-type,
.prose h1:first-of-type {
margin-top: 0 !important; /* No extra top margin */
margin-bottom: 1.5rem !important; /* Match breadcrumb spacing */
}

/* Remove any extra padding from containers */
.theme-doc-markdown.markdown {
padding-top: 0 !important;
}

/* Table header vertical alignment - align headers to top of cells */
table th {
vertical-align: top !important;
}

Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
---
id: quickstart-filter
title: Quickstart Guide
sidebar_label: Quickstarts
description: Choose your language and environment to find the right Keploy quickstart for you.
tags:
- quickstart
- tutorial
- guide
title: Quickstart filter
hide_table_of_contents: true
sidebar_label: Sample apps
---

# Keploy Quickstarts
Expand Down
File renamed without changes.
File renamed without changes.
10 changes: 7 additions & 3 deletions versioned_docs/version-3.0.0/quickstart/sample-apps.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
---
id: quickstart-filter
title: Quickstart filter
hide_table_of_contents: true
sidebar_label: Sample apps
title: Quickstart Guide
sidebar_label: Quickstarts
description: Choose your language and environment to find the right Keploy quickstart for you.
tags:
- quickstart
- tutorial
- guide
---

# Keploy Quickstarts

Check failure on line 12 in versioned_docs/version-3.0.0/quickstart/sample-apps.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/quickstart/sample-apps.md#L12

[Vale.Spelling] Did you really mean 'Quickstarts'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Quickstarts'?", "location": {"path": "versioned_docs/version-3.0.0/quickstart/sample-apps.md", "range": {"start": {"line": 12, "column": 10}}}, "severity": "ERROR"}

import QuickStartFilter from '../../../src/components/QuickStartFilter'

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion versioned_docs/version-3.0.0/server/linux/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: installation
id: linux-installation
title: Linux Installation
sidebar_label: Linux
tags:
Expand Down Expand Up @@ -34,7 +34,7 @@

## Manual Install

There are two ways to use Keploy eBPF in linux, you can use either use:

Check failure on line 37 in versioned_docs/version-3.0.0/server/linux/installation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/server/linux/installation.md#L37

[Vale.Spelling] Did you really mean 'linux'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'linux'?", "location": {"path": "versioned_docs/version-3.0.0/server/linux/installation.md", "range": {"start": {"line": 37, "column": 42}}}, "severity": "ERROR"}

1. [Natively in Linux](#linux-native).
2. Through [Using Docker](#using-docker).
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.0.0/server/macos/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: installation
id: macos-installation
title: MacOS Installation
sidebar_label: MacOS
tags:
Expand Down Expand Up @@ -106,7 +106,7 @@

Make API Calls using Postman, or cURL commands.

Keploy will capture the API calls you've conducted, generating test suites comprising **testcases (KTests) and data

Check failure on line 109 in versioned_docs/version-3.0.0/server/macos/installation.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/server/macos/installation.md#L109

[Vale.Spelling] Did you really mean 'KTests'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'KTests'?", "location": {"path": "versioned_docs/version-3.0.0/server/macos/installation.md", "range": {"start": {"line": 109, "column": 100}}}, "severity": "ERROR"}
mocks (KMocks)** in `YAML` format.

### Running Testcases
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: installation
id: windows-installation
title: Windows Installation
sidebar_label: Windows
tags:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
"id": "server/installation"
},
"keploy-cloud/cloud-installation",
"keploy-cloud/kubernetes-local-setup",
"running-keploy/cli-commands",
"running-keploy/rename-testcases",
"running-keploy/docker-tls",
Expand Down Expand Up @@ -170,7 +169,6 @@
"running-keploy/run-ai-generated-api-tests",
"running-keploy/api-testing-cicd",
"running-keploy/api-testing-webhook",
"running-keploy/api-testing-auth-setup",
{
"type": "doc",
"label": "FAQs",
Expand Down
2 changes: 2 additions & 0 deletions versioned_sidebars/version-3.0.0-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
"id": "server/installation"
},
"keploy-cloud/cloud-installation",
"keploy-cloud/kubernetes-local-setup",
"running-keploy/cli-commands",
"running-keploy/rename-testcases",
"running-keploy/docker-tls",
Expand Down Expand Up @@ -169,6 +170,7 @@
"running-keploy/run-ai-generated-api-tests",
"running-keploy/api-testing-cicd",
"running-keploy/api-testing-webhook",
"running-keploy/api-testing-auth-setup",
{
"type": "doc",
"label": "FAQs",
Expand Down
Loading
Loading