-
-
Notifications
You must be signed in to change notification settings - Fork 757
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into anshul/org-card-unit-test
- Loading branch information
Showing
112 changed files
with
16,310 additions
and
37,248 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| #!/usr/bin/env python3 | ||
| # -*- coding: UTF-8 -*- | ||
| """ | ||
| Script to make Markdown files MDX compatible. | ||
| This script scans Markdown files and escapes special characters (<, >, {, }) | ||
| to make them compatible with the MDX 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_mdx_characters(text): | ||
| """ | ||
| Escape special characters in a text string for MDX 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 MDX 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 MDX characters | ||
| new_content = escape_mdx_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 MDX compatibility. | ||
| Args: | ||
| None | ||
| Returns: | ||
| None | ||
| """ | ||
| parser = argparse.ArgumentParser(description="Make Markdown files MDX 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() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| module.exports = { | ||
| presets: [ | ||
| '@babel/preset-env', // Transforms modern JavaScript | ||
| '@babel/preset-typescript', // Transforms TypeScript | ||
| '@babel/preset-react', // Transforms JSX | ||
| ], | ||
| plugins: ['babel-plugin-transform-import-meta'], | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| import { defineConfig } from 'vite'; | ||
| import react from '@vitejs/plugin-react'; | ||
| import viteTsconfigPaths from 'vite-tsconfig-paths'; | ||
| import svgrPlugin from 'vite-plugin-svgr'; | ||
| import EnvironmentPlugin from 'vite-plugin-environment'; | ||
|
|
||
| export default defineConfig({ | ||
| // depending on your application, base can also be "/" | ||
| build: { | ||
| outDir: 'build', | ||
| }, | ||
| base: '', | ||
| plugins: [ | ||
| react(), | ||
| viteTsconfigPaths(), | ||
| EnvironmentPlugin('all'), | ||
| svgrPlugin({ | ||
| svgrOptions: { | ||
| icon: true, | ||
| // ...svgr options (https://react-svgr.com/docs/options/) | ||
| }, | ||
| }), | ||
| ], | ||
| server: { | ||
| // this ensures that the browser opens upon server start | ||
| open: true, | ||
| // this sets a default port to 3000 | ||
| port: 4321, | ||
| }, | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.