add data category and update comments to support codeBlocks #8015
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
reesscot
reviewed
Oct 10, 2024
| @@ -15,6 +16,23 @@ export const ApiComment = ({ apiComment, codeBlock }: ApiCommentProps) => { | |||
| } | |||
| const commentList = apiComment.map((snippet, idx) => { | |||
| if (snippet.kind === 'code') { | |||
| if (snippet.text.indexOf('```') !== -1) { | |||
| // If the comment contains a code block extract the language and render an MDXCode component | |||
There was a problem hiding this comment.
can you give an example of this?
There was a problem hiding this comment.
This is the current use case
{
"kind": "code",
"text": "```ts\nimport { DataStore, syncExpression } from 'aws-amplify/datastore';\nimport { Post, Comment } from './models';\n\n\nDataStore.configure({\n\tsyncExpressions: [\n\t\tsyncExpression(Post, () => {\n\t\t\treturn (post) => post.rating.gt(5);\n\t\t}),\n\t\tsyncExpression(Comment, () => {\n\t\t\treturn (comment) => comment.status.eq('active');\n\t\t})\n\t]\n});\n```"
}
The comment node is marked as code but the text inside the comment could be either a code block or just a singular code tag, we are using ``` to differentiate the code blocks from the ` code tags
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 of changes:
Adding the data category to api docs
adding support for code blocks in api comments
fix issue with rendering certain types of typeArguments
Staging Site: https://data-api-category.dmhjrabi3pkql.amplifyapp.com/
Related GitHub issue #, if available:
Instructions
If this PR should not be merged upon approval for any reason, please submit as a DRAFT
Which product(s) are affected by this PR (if applicable)?
Which platform(s) are affected by this PR (if applicable)?
Please add the product(s)/platform(s) affected to the PR title
Checks
Does this PR conform to the styleguide?
Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.
Are any files being deleted with this PR? If so, have the needed redirects been created?
Are all links in MDX files using the MDX link syntax rather than HTML link syntax?
ref: MDX:
[link](https://docs.amplify.aws/)HTML:
<a href="https://docs.amplify.aws/">link</a>When this PR is ready to merge, please check the box below
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.