Repository navigation
docs: fix SuspenseList experimental callout - #1684
Open
RaphaelFakhri wants to merge 1 commit into
Open
RaphaelFakhri wants to merge 1 commit into
RaphaelFakhri wants to merge 1 commit into
Conversation
|
|
✅ Deploy Preview for solid-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
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(required)
The
<SuspenseList>reference page opens its experimental notice with:::[warning]. That is not a valid container directive (a directive needs a name before the label), soremark-directiveleaves it as plain text. The live page at https://docs.solidjs.com/reference/components/suspense-list shows the literal text:::[warning] This is an experimental component :::instead of a callout.This PR changes the opener to
:::caution, one of the callout types the theme supports (note,tip,advanced,caution,danger) and the type other reference pages use for warnings, such asclasslist.mdxandinnerhtml.mdx.To verify, parse every page under
src/routeswith the same remark plugins Solidbase uses (remark-mdx,remark-frontmatter,remark-gfm,remark-directive) and look for text nodes that start with::::suspense-list.mdx:20).Related issues & labels