Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Missing Sections Issue while converting JSDoc to MDX #1864

Merged
merged 15 commits into from
Sep 25, 2024
Merged

Fix Missing Sections Issue while converting JSDoc to MDX #1864

merged 15 commits into from
Sep 25, 2024

Conversation

devvaannsh
Copy link
Contributor

@devvaannsh devvaannsh commented Sep 21, 2024

Fix the issue of missing sections during the conversion of JSDoc comments to MDX format.
Now, all the jsdoc content is added in MDX files.

Rewrote the logic of the script file and also improve its readability and maintainibility.

Tested on both Windows and Linux. Works as expected.

let content = fs.readFileSync(mdxFile, "utf8");

// Escape curly braces
content = content.replace(/\{/g, '\\{');

Check failure

Code scanning / CodeQL

Incomplete string escaping or encoding High

This does not escape backslash characters in the input.
build/api-docs-generator.js Outdated Show resolved Hide resolved
Copy link

@abose abose merged commit bf2d1fa into phcode-dev:main Sep 25, 2024
2 checks passed
@abose
Copy link
Member

abose commented Sep 25, 2024

LGTM Merging. Thanks for contributing @devvaannsh

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