fix md_mpx_format_adjuster.py script

.github/workflows/md_mpx_format_adjuster.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python3
+# -*- coding: UTF-8 -*-
+"""
+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

@@ -91,9 +91,14 @@ jobs:
 
       - name: Generate Documentation of Markdown pages
         run: |
-          yarn global add typedoc
-          yarn add typedoc-plugin-markdown
-          yarn typedoc --entryPoints src/components src/screens --out talawa-admin-docs --plugin typedoc-plugin-markdown --theme markdown --entryPointStrategy expand --exclude "**/*.test.ts" --exclude "**/*.css"
+          npm install --global typedoc
+          npm install typedoc-plugin-markdown
+          npm install --save-dev @types/node
+          npx typedoc --entryPoints src/components src/screens --out talawa-admin-docs --plugin typedoc-plugin-markdown --theme markdown --entryPointStrategy expand --exclude "**/*.test.ts" --exclude "**/*.css"
+
+      - name: Make Markdown Files MPX Compatible
+        run: python ./.github/workflows/md_mpx_format_adjuster.py --directory talawa-admin-docs
+
 
       - name: Checking doc updated
         id: DocUpdated

CODE_STYLE.md

@@ -175,7 +175,7 @@ Follow this [link](https://getbootstrap.com/docs/5.3/customize/sass/) to learn h
 
 **File Structure**
 
-- `src/assets/scss/components/{partialFile}.scss` - where the {partialFile} are the following files
+- `src/assets/scss/components/{'{partialFile}'}.scss` - where the {'{partialFile}'} are the following files
   - **_accordion.scss**
   - **_alert.scss**
   - **_badge.scss**
@@ -195,12 +195,12 @@ Follow this [link](https://getbootstrap.com/docs/5.3/customize/sass/) to learn h
   - **_progress.scss**
   - **_spinners.scss**
 
-- `src/assets/scss/content/{partialFile}.scss` - where the {partialFile} are the following files
+- `src/assets/scss/content/{'{partialFile}'}.scss` - where the {'{partialFile}'} are the following files
   - **_table.scss**
   - **_typography.scss**
 
 
-- `src/assets/scss/forms/{partialFile}.scss` - where the {partialFile} are the following files
+- `src/assets/scss/forms/{'{partialFile}'}.scss` - where the {'{partialFile}'} are the following files
   - **_check-radios.scss**
   - **_floating-label.scss**
   - **_form-control.scss**

talawa-admin-docs/classes/components_AddOn_support_services_Plugin_helper.default.md

@@ -26,11 +26,11 @@
 
 ### fetchInstalled
 
-▸ **fetchInstalled**(): `Promise`<`any`\>
+▸ **fetchInstalled**(): `Promise`\<`any`\>
 
 #### Returns
 
-`Promise`<`any`\>
+`Promise`\<`any`\>
 
 #### Defined in
 
@@ -40,11 +40,11 @@ ___
 
 ### fetchStore
 
-▸ **fetchStore**(): `Promise`<`any`\>
+▸ **fetchStore**(): `Promise`\<`any`\>
 
 #### Returns
 
-`Promise`<`any`\>
+`Promise`\<`any`\>
 
 #### Defined in
 
@@ -54,7 +54,7 @@ ___
 
 ### generateLinks
 
-▸ **generateLinks**(`plugins`): { `name`: `string` ; `url`: `string`  }[]
+▸ **generateLinks**(`plugins`): \{ `name`: `string` ; `url`: `string`  \}[]
 
 #### Parameters
 
@@ -64,7 +64,7 @@ ___
 
 #### Returns
 
-{ `name`: `string` ; `url`: `string`  }[]
+\{ `name`: `string` ; `url`: `string`  \}[]
 
 #### Defined in
 

talawa-admin-docs/interfaces/components_CheckIn_types.InterfaceAttendeeCheckIn.md

@@ -26,7 +26,7 @@ ___
 
 ### checkIn
 
-• **checkIn**: ``null`` \| { `_id`: `string` ; `allotedRoom`: `string` ; `allotedSeat`: `string` ; `time`: `string`  }
+• **checkIn**: ``null`` \| \{ `_id`: `string` ; `allotedRoom`: `string` ; `allotedSeat`: `string` ; `time`: `string`  \}
 
 #### Defined in
 

talawa-admin-docs/interfaces/components_CheckIn_types.InterfaceModalProp.md

@@ -26,7 +26,7 @@ ___
 
 ### handleClose
 
-• **handleClose**: () => `void`
+• **handleClose**: () =\> `void`
 
 #### Type declaration
 

talawa-admin-docs/interfaces/components_CheckIn_types.InterfaceTableCheckIn.md

@@ -18,7 +18,7 @@
 
 ### checkIn
 
-• **checkIn**: ``null`` \| { `_id`: `string` ; `allotedRoom`: `string` ; `allotedSeat`: `string` ; `time`: `string`  }
+• **checkIn**: ``null`` \| \{ `_id`: `string` ; `allotedRoom`: `string` ; `allotedSeat`: `string` ; `time`: `string`  \}
 
 #### Defined in
 

talawa-admin-docs/interfaces/components_LeftDrawerOrg_LeftDrawerOrg.InterfaceLeftDrawerProps.md

@@ -48,7 +48,7 @@ ___
 
 ### setHideDrawer
 
-• **setHideDrawer**: `Dispatch`<`SetStateAction`<``null`` \| `boolean`\>\>
+• **setHideDrawer**: `Dispatch`\<`SetStateAction`\<``null`` \| `boolean`\>\>
 
 #### Defined in
 

talawa-admin-docs/interfaces/components_LeftDrawer_LeftDrawer.InterfaceLeftDrawerProps.md

@@ -36,7 +36,7 @@ ___
 
 ### setHideDrawer
 
-• **setHideDrawer**: `Dispatch`<`SetStateAction`<``null`` \| `boolean`\>\>
+• **setHideDrawer**: `Dispatch`\<`SetStateAction`\<``null`` \| `boolean`\>\>
 
 #### Defined in
 

talawa-admin-docs/modules/components_AddOn_AddOn.default.md

@@ -22,7 +22,7 @@
 | Name | Type |
 | :------ | :------ |
 | `children` | ``null`` |
-| `extras` | {} |
+| `extras` | \{\} |
 | `name` | `string` |
 
 #### Defined in
@@ -39,9 +39,9 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `children` | `Requireable`<`any`\> |
-| `extras` | `Requireable`<`InferProps`<{ `actions`: `Requireable`<`InferProps`<{}\>\> ; `components`: `Requireable`<`InferProps`<{}\>\>  }\>\> |
-| `name` | `Requireable`<`string`\> |
+| `children` | `Requireable`\<`any`\> |
+| `extras` | `Requireable`\<`InferProps`\<\{ `actions`: `Requireable`\<`InferProps`\<\{\}\>\> ; `components`: `Requireable`\<`InferProps`\<\{\}\>\>  \}\>\> |
+| `name` | `Requireable`\<`string`\> |
 
 #### Defined in
 

talawa-admin-docs/modules/components_AddOn_core_AddOnEntry_AddOnEntry.default.md

@@ -41,11 +41,11 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `configurable` | `Requireable`<`boolean`\> |
-| `description` | `Requireable`<`string`\> |
-| `enabled` | `Requireable`<`boolean`\> |
-| `isInstalled` | `Requireable`<`boolean`\> |
-| `title` | `Requireable`<`string`\> |
+| `configurable` | `Requireable`\<`boolean`\> |
+| `description` | `Requireable`\<`string`\> |
+| `enabled` | `Requireable`\<`boolean`\> |
+| `isInstalled` | `Requireable`\<`boolean`\> |
+| `title` | `Requireable`\<`string`\> |
 
 #### Defined in
 

talawa-admin-docs/modules/components_AddOn_core_AddOnRegister_AddOnRegister.default.md

@@ -37,7 +37,7 @@ ___
 
 | Name | Type |
 | :------ | :------ |
-| `createdBy` | `Requireable`<`string`\> |
+| `createdBy` | `Requireable`\<`string`\> |
 
 #### Defined in
 

talawa-admin-docs/modules/components_ChangeLanguageDropdown_ChangeLanguageDropDown.md

@@ -13,7 +13,7 @@
 
 ### changeLanguage
 
-▸ **changeLanguage**(`languageCode`): `Promise`<`void`\>
+▸ **changeLanguage**(`languageCode`): `Promise`\<`void`\>
 
 #### Parameters
 
@@ -23,7 +23,7 @@
 
 #### Returns
 
-`Promise`<`void`\>
+`Promise`\<`void`\>
 
 #### Defined in
 

talawa-admin-docs/modules/components_CheckIn_TableRow.md

@@ -20,7 +20,7 @@
 | :------ | :------ |
 | `«destructured»` | `Object` |
 | › `data` | [`InterfaceTableCheckIn`](../interfaces/components_CheckIn_types.InterfaceTableCheckIn.md) |
-| › `refetch` | () => `void` |
+| › `refetch` | () =\> `void` |
 
 #### Returns
 

talawa-admin-docs/modules/components_CheckIn_mocks.md

@@ -14,7 +14,7 @@
 
 ### checkInMutationSuccess
 
-• `Const` **checkInMutationSuccess**: { `request`: { `query`: `DocumentNode` = MARK\_CHECKIN; `variables`: { `allotedRoom`: `string` = ''; `allotedSeat`: `string` = ''; `eventId`: `string` = 'event123'; `userId`: `string` = 'user123' }  } ; `result`: { `data`: { `checkIn`: { `_id`: `string` = '123' }  }  }  }[]
+• `Const` **checkInMutationSuccess**: \{ `request`: \{ `query`: `DocumentNode` = MARK\_CHECKIN; `variables`: \{ `allotedRoom`: `string` = ''; `allotedSeat`: `string` = ''; `eventId`: `string` = 'event123'; `userId`: `string` = 'user123' \}  \} ; `result`: \{ `data`: \{ `checkIn`: \{ `_id`: `string` = '123' \}  \}  \}  \}[]
 
 #### Defined in
 
@@ -24,7 +24,7 @@ ___
 
 ### checkInMutationUnsuccess
 
-• `Const` **checkInMutationUnsuccess**: { `error`: `Error` ; `request`: { `query`: `DocumentNode` = MARK\_CHECKIN; `variables`: { `allotedRoom`: `string` = ''; `allotedSeat`: `string` = ''; `eventId`: `string` = 'event123'; `userId`: `string` = 'user123' }  }  }[]
+• `Const` **checkInMutationUnsuccess**: \{ `error`: `Error` ; `request`: \{ `query`: `DocumentNode` = MARK\_CHECKIN; `variables`: \{ `allotedRoom`: `string` = ''; `allotedSeat`: `string` = ''; `eventId`: `string` = 'event123'; `userId`: `string` = 'user123' \}  \}  \}[]
 
 #### Defined in
 
@@ -34,7 +34,7 @@ ___
 
 ### checkInQueryMock
 
-• `Const` **checkInQueryMock**: { `request`: { `query`: `DocumentNode` = EVENT\_CHECKINS; `variables`: { `id`: `string` = 'event123' }  } ; `result`: { `data`: [`InterfaceAttendeeQueryResponse`](../interfaces/components_CheckIn_types.InterfaceAttendeeQueryResponse.md) = checkInQueryData }  }[]
+• `Const` **checkInQueryMock**: \{ `request`: \{ `query`: `DocumentNode` = EVENT\_CHECKINS; `variables`: \{ `id`: `string` = 'event123' \}  \} ; `result`: \{ `data`: [`InterfaceAttendeeQueryResponse`](../interfaces/components_CheckIn_types.InterfaceAttendeeQueryResponse.md) = checkInQueryData \}  \}[]
 
 #### Defined in
 

talawa-admin-docs/modules/components_EventCalendar_EventCalendar.md

@@ -12,18 +12,18 @@
 
 ### default
 
-▸ **default**(`props`, `context?`): ``null`` \| `ReactElement`<`any`, `any`\>
+▸ **default**(`props`, `context?`): ``null`` \| `ReactElement`\<`any`, `any`\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `props` | `PropsWithChildren`<`InterfaceCalendarProps`\> |
+| `props` | `PropsWithChildren`\<`InterfaceCalendarProps`\> |
 | `context?` | `any` |
 
 #### Returns
 
-``null`` \| `ReactElement`<`any`, `any`\>
+``null`` \| `ReactElement`\<`any`, `any`\>
 
 #### Defined in
 

talawa-admin-docs/modules/components_TaskModals_UpdateTaskModal.md

@@ -22,11 +22,11 @@
 
 | Name | Type |
 | :------ | :------ |
-| `handleClose` | () => `void` |
-| `organization` | { `_id`: `string` ; `members`: `InterfaceUser`[]  } |
+| `handleClose` | () =\> `void` |
+| `organization` | \{ `_id`: `string` ; `members`: `InterfaceUser`[]  \} |
 | `organization._id` | `string` |
 | `organization.members` | `InterfaceUser`[] |
-| `refetchData` | () => `void` |
+| `refetchData` | () =\> `void` |
 | `show` | `boolean` |
 | `task` | `InterfaceTask` |
 

talawa-admin-docs/modules/components_UserPasswordUpdate_UserPasswordUpdate.md

@@ -12,18 +12,18 @@
 
 ### default
 
-▸ **default**(`props`, `context?`): ``null`` \| `ReactElement`<`any`, `any`\>
+▸ **default**(`props`, `context?`): ``null`` \| `ReactElement`\<`any`, `any`\>
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `props` | `PropsWithChildren`<`InterfaceUserPasswordUpdateProps`\> |
+| `props` | `PropsWithChildren`\<`InterfaceUserPasswordUpdateProps`\> |
 | `context?` | `any` |
 
 #### Returns
 
-``null`` \| `ReactElement`<`any`, `any`\>
+``null`` \| `ReactElement`\<`any`, `any`\>
 
 #### Defined in