Build docs of services category in a separate folder #3453
Merged
Conversation
This file contains hidden or 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
Inbal-Tish
reviewed
Dec 11, 2024
|
|
||
| if (!fs.existsSync(dirPath)) { | ||
| fs.mkdirSync(dirPath, {recursive: true}); | ||
| } | ||
|
|
||
| fs.writeFileSync(`${dirPath}/${component.name}.md`, content, {encoding: 'utf8'}); | ||
| fs.writeFileSync(`${dirPath}/${component.name.replaceAll(' ', '_')}.md`, content, {encoding: 'utf8'}); |
There was a problem hiding this comment.
Why the replaceAll here?
There was a problem hiding this comment.
When Docusaurus read the md files, they can't have spaces in them
Usually the components names (in api.json) are one word
Now that I want to support building other types of md files, the name doesn't represent just components name.
for example in the private PR I have a file with a name of RNN TopBar
|
@ethanshar Looks good, small question in the comments |
Inbal-Tish
approved these changes
Dec 11, 2024
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.
Description
I want to create (in private) some api.json files that will be part of the services section (not components)
I updated the build script to create relevant md files in a separate (services) folder
Changelog
N/A
Additional info