docs: enable twoslash for some code snippets #25679
Merged
+68
−59
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
|
|
✅ Live Preview ready!
|
danielroe
approved these changes
Feb 7, 2024
|
This makes me very happy. |
Merged
This was referenced Feb 13, 2024
TheAlexLichter
pushed a commit
that referenced
this pull request
Feb 18, 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.
This enables TwoSlash support for nuxt.com in nuxt/nuxt.com#1486
Here is an example:
I manually checked every code snippet I enabled. Since the docs and nuxt.com are different repos, currently, you have to manually link them to verify the works (TwoSlash also verifies the types and throws when there are type errors, this could be handly to typecheck the docs later on). I am working with Orta to bring
twoslash-cliso that later, we can verify the code snippets in CI to guard against type errors.This PR is pure additional, should not break existing usages and is good to merge.