Tested the push workflow and made the md files mpx compatible (#1769)

* Tested the push workflow and made the md files mpx compatible

* changes to schema.graphql

---------

Co-authored-by: Aditya Agarwal <adi790u@Adityas-MacBook-Air.local>

Author: adi790uu

.github/workflows/md_to_mpx.py

@@ -0,0 +1,86 @@
+"""
+Script to make Markdown files MPX compatible.
+This script scans Markdown files and escapes special characters (<, >, {, })
+to make them compatible with the MPX standard used in Docusaurus v3.
+This script complies with:
+    1) Pylint
+    2) Pydocstyle
+    3) Pycodestyle
+    4) Flake8
+"""
+
+import os
+import argparse
+import re
+
+def escape_mpx_characters(text):
+    """
+    Escape special characters in a text string for MPX compatibility.
+    Avoids escaping already escaped characters.
+    Args:
+        text: A string containing the text to be processed.
+    Returns:
+        A string with special characters (<, >, {, }) escaped, avoiding
+        double escaping.
+    """
+    # Regular expressions to find unescaped special characters
+    patterns = {
+        "<": r"(?<!\\)<",
+        ">": r"(?<!\\)>",
+        "{": r"(?<!\\){",
+        "}": r"(?<!\\)}"
+    }
+
+    # Replace unescaped special characters
+    for char, pattern in patterns.items():
+        text = re.sub(pattern, f"\\{char}", text)
+
+    return text
+
+def process_file(filepath):
+    """
+    Process a single Markdown file for MPX compatibility.
+    Args:
+        filepath: The path to the Markdown file to process.
+    Returns:
+        None, writes the processed content back to the file only if there are changes.
+    """
+    with open(filepath, 'r', encoding='utf-8') as file:
+        content = file.read()
+
+    # Escape MPX characters
+    new_content = escape_mpx_characters(content)
+
+    # Write the processed content back to the file only if there is a change
+    if new_content != content:
+        with open(filepath, 'w', encoding='utf-8') as file:
+            file.write(new_content)
+
+def main():
+    """
+    Main function to process all Markdown files in a given directory.
+    Scans for all Markdown files in the specified directory and processes each
+    one for MPX compatibility.
+    Args:
+        None
+    Returns:
+        None
+    """
+    parser = argparse.ArgumentParser(description="Make Markdown files MPX compatible.")
+    parser.add_argument(
+        "--directory",
+        type=str,
+        required=True,
+        help="Directory containing Markdown files to process."
+    )
+
+    args = parser.parse_args()
+
+    # Process each Markdown file in the directory
+    for root, _, files in os.walk(args.directory):
+        for file in files:
+            if file.lower().endswith(".md"):
+                process_file(os.path.join(root, file))
+
+if __name__ == "__main__":
+    main()

.github/workflows/push.yml

@@ -108,6 +108,9 @@ jobs:
           npm install typedoc-plugin-markdown
           npm i --save-dev @types/node
           npx typedoc --entryPoints src --out talawa-api-docs --plugin typedoc-plugin-markdown --theme markdown --entryPointStrategy expand
+      
+      - name: Make Markdown Files MPX Compatible
+        run: python3 .github/workflows/md_to_mpx.py --directory talawa-api-docs 
 
       - name: Checking doc updated
         id: DocUpdated

README.md

@@ -1,4 +1,5 @@
 # Talawa API
+
 💬 Join the community on Slack. The link can be found in the `Talawa` [README.md](https://github.com/PalisadoesFoundation/talawa) file.
 
 [![N|Solid](public/markdown/images/talawa-logo-lite-200x200.png)](https://github.com/PalisadoesFoundation/talawa-api)
@@ -24,11 +25,10 @@ Core features include:
 
 <!-- toc -->
 
-- [Talawa API](#talawa-api)
-  - [Talawa Components](#talawa-components)
-  - [Documentation](#documentation)
-  - [Installation](#installation)
-  - [Image Upload](#image-upload)
+- [Talawa Components](#talawa-components)
+- [Documentation](#documentation)
+- [Installation](#installation)
+- [Image Upload](#image-upload)
 
 <!-- tocstop -->