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

Document use of Astro’s JSX types #1005

Merged
merged 3 commits into from
Jul 15, 2022
Merged

Document use of Astro’s JSX types #1005

merged 3 commits into from
Jul 15, 2022

Conversation

delucis
Copy link
Member

@delucis delucis commented Jul 15, 2022

What kind of changes does this PR include?

  • New or updated content

Description

@Princesseuh I tried these examples out in the docs repo and it seems to work without the need for the /// directive. Would you mind reading through this and letting me know if you think this covers what you imagined? 💜

@delucis delucis added the add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. label Jul 15, 2022
@delucis delucis requested a review from Princesseuh July 15, 2022 09:13
@netlify
Copy link

netlify bot commented Jul 15, 2022

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 99fa11a
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/62d15112dadc040008b6c632
😎 Deploy Preview https://deploy-preview-1005--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Co-authored-by: Erika <3019731+Princesseuh@users.noreply.github.com>
@Princesseuh
Copy link
Member

@Princesseuh I tried these examples out in the docs repo and it seems to work without the need for the /// directive.

This is true in Astro files only because the language server inject those types into Astro files in the editor, however it's technically improper code 😄 Additionally, it is needed in other files, so definitely needs to be documented. Our own image integration use it in a .ts file, for instance

@delucis
Copy link
Member Author

delucis commented Jul 15, 2022

@Princesseuh Added a note to that effect:
image

@delucis delucis merged commit a1ecd87 into main Jul 15, 2022
@delucis delucis deleted the delucis/extending-jsx branch July 15, 2022 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
add new content Document something that is not in docs. May require testing, confirmation, or affect other pages.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document using / extending the Astro JSX definitions
2 participants