[Docs] Added generate-markdown scripts#3142
Merged
flyingcircle merged 14 commits intoreact-native-elements:nextfrom Jul 16, 2021
Merged
[Docs] Added generate-markdown scripts#3142flyingcircle merged 14 commits intoreact-native-elements:nextfrom
flyingcircle merged 14 commits intoreact-native-elements:nextfrom
Conversation
…-native-elements into khushal87-markdown-generate
…/khushal87/react-native-elements into khushal87-markdown-generate
…-native-elements into khushal87-markdown-generate
Codecov Report
@@ Coverage Diff @@
## next #3142 +/- ##
=======================================
Coverage ? 83.87%
=======================================
Files ? 78
Lines ? 1687
Branches ? 666
=======================================
Hits ? 1415
Misses ? 268
Partials ? 4
Continue to review full report at Codecov.
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What kind of change does this PR introduce?
This PR introduces adding new generate markdown scripts which use
json2md. The output from the previous scripts is served into this to generate markdown out of it and is finally stored in the.docgenfolder.Did you add tests for your changes?
No, tests will be dealt with later if required.
If relevant, did you update the documentation?
This will be done in a single PR later when the entire script will be live.
Summary
This is done using the script written in generateMarkdown.ts. The script has a primary function
generateMarkdownwhich is called in the index.ts for every component file and then the output is stored in the .docgen directory. The scripts have custom converters for the purpose of generating the markdown in the required format including the Header, imports, prop link, props data, etc. Finally, this structure gives the output in the form of a single markdown output for a file. This is then stored in the directory.Does this PR introduce a breaking change?
No.
Other information
Not required.
Tags
#gsoc #docs-autogen #khushal87