Add Var component support #37
Merged
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
|
Stacked on #36 |
|
Preview details
|
ptgott
force-pushed
the
paul.gottschling/2024-11-26-code-snippet
branch
from
185dee2 to
cbb5e66
Compare
Base automatically changed from
paul.gottschling/2024-11-26-code-snippet
to
main
December 4, 2024 18:44
Closes #14 Copy the `Var` component `VarsProvider` context provider from `gravitational/docs` and adapt them to the Docusaurus site. Edit the `remark-update-tags` to not remove `Var` components before building the docs site. Fix the visitor test function in `rehype-hljs`. Check for `Var` placeholders as well as `Var` tags, since otherwise the test won't work in the second `visit` call. Also improve `rehype-hljs` by highlighting any unlabeled code snippets as `text` to avoid rendering issues.
ptgott
force-pushed
the
paul.gottschling/2024-12-3-var
branch
from
759cee1 to
aa245fe
Compare
|
@taraspos I fixed this issue in aa245fe |
Don't check text values in the visitor test function. Since we execute this function against every rehype AST node in the docs, don't create a RegExp and match it to find `Var` tags or placeholders. We do this inside the visitor functions anyway.
taraspos
approved these changes
Dec 6, 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.
Closes #14
Closes #6
Copy the
VarcomponentVarsProvidercontext provider fromgravitational/docsand adapt them to the Docusaurus site. Edit theremark-update-tagsto not removeVarcomponents before building the docs site.Fix the visitor test function in
rehype-hljs. Check forVarplaceholders as well asVartags, since otherwise the test won't work in the secondvisitcall.