-
-
Notifications
You must be signed in to change notification settings - Fork 129
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
Script to automatically generate Markdown API docs from source code. #1870
Merged
Conversation
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
const outputDir = path.join(MD_FILES_DIR, relativePath); | ||
createDir(outputDir); | ||
const outputFileName = path.join(outputDir, `${fileName}.md`); | ||
execSync(`npx jsdoc-to-markdown ${file} > ${outputFileName}`); |
Check warning
Code scanning / CodeQL
Shell command built from environment values Medium
This shell command depends on an uncontrolled .
file name
Error loading related location
Loading
abose
reviewed
Sep 26, 2024
abose
reviewed
Sep 26, 2024
abose
requested changes
Sep 27, 2024
Quality Gate passedIssues Measures |
LGTM. Merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes :-
npm run createMDDocs
)