Skip to content

Conversation

AryanCruise
Copy link

@AryanCruise AryanCruise commented Sep 25, 2025

What has changed?

This PR corrects the Markdown formatting in the installation guide (installation_tabs.md), specifically within the Linux, macOS, and Windows sections.

This resolves a rendering bug where bash code blocks were not properly indented inside their numbered list items. This lack of indentation caused the Markdown parser to break the list's structure, leading to visual alignment issues. The fix ensures all lists containing code blocks now render correctly with consistent styling.

This PR Resolves #3022 (issue raised on keploy/keploy)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue).

How Has This Been Tested?

I have tested these changes by running the development server locally with npm run start and visually confirming that the fix is working as expected.

The numbered list in "Option 1: Install Keploy with Lima" now renders correctly without any alignment or styling issues. I also confirmed the same fix for the Docker installation steps.

As requested, I have also run npm run build and npm run serve to verify the production build.

image image

Before:

(Screenshot of the broken page)
image

After:

(Screenshot of the fixed page)
image

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you and congratulations 🎉 for opening your very first pull request in keploy

Copy link
Contributor

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

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

Hey @AryanCruise can you please update the PR title, also please don't update everything for the installation tab, format only the part which is not formatted properly

@AryanCruise
Copy link
Author

Hey @AryanCruise can you please update the PR title, also please don't update everything for the installation tab, format only the part which is not formatted properly

Thanks for the feedback! I can definitely update the title.

I'm happy to reduce the scope of this PR to align with the original issue. The reason I made the extra changes was that I found the same formatting error occurred in several other places, and I thought it would be best to fix them all at once for consistency.

@AryanCruise AryanCruise changed the title Fixes #3022 : Correct Markdown formatting for lists with code blocks Fix: Formatting issue in Docs Page [Installation Section] Sep 26, 2025
@AryanCruise AryanCruise force-pushed the docs-fix-styling-3022 branch 2 times, most recently from cf0213c to b7623cd Compare September 26, 2025 17:53
@AryanCruise
Copy link
Author

Made the changes, as asked by you @Achanandhi-M (do let me know if any changes are required)

Before:

image

After:

image

npm run build and npm run serve (screenshot):

image

Copy link
Contributor

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

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

Hey @AryanCruise can you please fix the same issue in the windows installation section, please make sure the formatting is good for every OS installation

@AryanCruise AryanCruise force-pushed the docs-fix-styling-3022 branch from aef7c24 to dcbf09b Compare October 7, 2025 16:39
@AryanCruise
Copy link
Author

In my recent commit, I ensured that the formatting was good and consistent across all OSs on the installation page.

This commit standardizes the layout to improve readability and ensure a consistent user experience across Windows, macOS, and Linux.

Kindly please review the changes @Achanandhi-M
Thank you!

Linux OS:
image

MacOS:
image

Windows:
image

npm build and serve:
image
image

Copy link
Contributor

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

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

Hey @AryanCruise,
I’ve reviewed your PR — the 🎬 Start Capturing Test Cases section should be aligned properly with the previous section. In the current PR, the alignment isn’t consistent. Please fix the formatting issue. For reference, check the current live section and make the same changes there too.

@AryanCruise AryanCruise force-pushed the docs-fix-styling-3022 branch from e80f5ee to bd7a8e8 Compare October 8, 2025 11:40
@AryanCruise
Copy link
Author

I have formatted as mentioned by adding a margin before the code blocks and giving numbering for each step.

Kindly review it @Achanandhi-M

Live website:
image

Localhost:
image

npm build and serve:
image
image

Copy link
Contributor

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

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

Hey @AryanCruise I think we don't want the changes in the components folder

@AryanCruise
Copy link
Author

Hey @AryanCruise I think we don't want the changes in the components folder

But, that's the only way to format the 🎬 Start Capturing test cases section as mentioned by you earlier to make changes in it.

I have searched for a .md file for that, unlike the installation_tabs.md file in which I made changes earlier, but I haven't found one. I think that section is directly made in .js without using a .md file.

@Achanandhi-M
Copy link
Contributor

Hey @AryanCruise Our requirement is too align everything equally in the page, but in this current PR the installation section and the capturing test cases not formatted equally i am asking you to make it properly aligned for that you don't need to update any js file

@AryanCruise AryanCruise force-pushed the docs-fix-styling-3022 branch from bd7a8e8 to f61e2e3 Compare October 13, 2025 14:13
}

.DocSearch-Button {
@apply mr-[-18px] !important;
Copy link
Author

Choose a reason for hiding this comment

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

I haven't changed this, Maybe the actual code has changed on GitHub, which I have copied and changed recently between my last clone.

@AryanCruise
Copy link
Author

Hi @Achanandhi-M , I removed the changes I made earlier in the JS file section. I am not able to make the changes regarding the formatting of "Start Capturing Section."

Although I have fixed the issue that was raised.

Copy link
Contributor

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

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

Can you please create a fresh PR for this one, with proper code changes and the title and description?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants