Add a script to validate Markdown formatting in documentation

[Abhijais4896]

Problem

This repository contains several Markdown documentation files such as:

• README.md
• docs/*.md
• examples documentation

Over time, formatting inconsistencies may appear in these files, for example:

• incorrect heading hierarchy
• trailing whitespace
• images without alt text
• empty or malformed links

Currently these issues are usually detected during manual reviews.

Proposed Solution

Introduce a small script that automatically validates Markdown formatting across the repository.

The script could check for common issues such as:

• skipped heading levels (e.g., H2 → H4)
• trailing whitespace
• images without alt text
• empty Markdown links

The script could scan all Markdown files in the repository and print warnings for formatting violations.

Possible Implementation

A simple implementation could be created using Python or an existing Markdown linting tool.

Example script location:

scripts/markdown_validator.py

The script could scan:

• README.md
• docs/
• examples/

Benefits

• improves documentation consistency
• helps contributors detect formatting issues early
• reduces manual review effort

If this improvement is considered useful, I would be happy to implement the script and submit a pull request.

[rainyyyyshrrr12]

Hi
I would like to work on this issue. I’m planning to add a simple Python script (e.g., scripts/markdown_validator.py) that scans all .md files in the repository and prints warnings for common issues like trailing whitespace, empty links, and images without alt text.
Please let me know if this approach works or if you prefer using a specific Markdown linting tool. Thanks!

[Danzombie]

Proposed Fix or Improvement

The issue describes a problem with the formatting and links in the “Other Tools” section of the Hindi documentation file. The layout is broken and some links are no longer working, which makes it harder for users reading the Hindi version of the documentation to follow the instructions.

To fix this issue, the affected documentation file should be opened and the “Other Tools” section should be reviewed. Each link in that section should be tested to confirm that it leads to a valid page. Any links that no longer work should be replaced with updated resources or removed if they are no longer relevant.

The Markdown formatting should also be checked to ensure the list structure is displayed correctly on GitHub. This includes verifying bullet points, indentation, and proper link syntax. After fixing the formatting and updating the links, the contributor could submit a pull request so the maintainers can review the changes and merge them into the repository.