Introduce support for Docusaurus 3.5.0+ #919
Merged
+1,020
−1,115
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
|
Size Change: -5.24 MB (-38.76%) 🎉 Total Size: 8.28 MB
ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit b06fdcc): https://docusaurus-openapi-36b86--pr919-xgjyuhft.web.app (expires Sun, 15 Sep 2024 16:15:49 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
2 tasks
IanVS
reviewed
Aug 27, 2024
| import type { Props } from "@theme/DocItem"; | ||
| import DocItemLayout from "@theme/DocItem/Layout"; |
There was a problem hiding this comment.
It looks like this change caused a visual update to generated API pages. Previously, the pagination at the bottom of the page was constrained to the center portion of the page, now after this update, the pagination also stretches into the right sidebar. We prefer the way it was previously. Is there any way to restore that?
Before:
After:
There was a problem hiding this comment.
Good catch @IanVS! I thought I could get away with not including Layout in our theme but didn't notice this side effect. Should be an easy fix.
If you need a fix sooner, you can swizzle Layout and use the useDoc hook to extract api from front matter, which can be used to conditionally set the footer/paginator col width:
Snippet:
<div className="row">
<div className={clsx("col", !docTOC.hidden && styles.docItemCol)}>
{unlisted && <Unlisted />}
<DocVersionBanner />
<div className={styles.docItemContainer}>
<article>
<DocBreadcrumbs />
<DocVersionBadge />
{docTOC.mobile}
<DocItemContent>{children}</DocItemContent>
<div className="row">
<div className={clsx("col", api ? "col--7" : "col--12")}>
<DocItemFooter />
</div>
</div>
</article>
<div className="row">
<div className={clsx("col", api ? "col--7" : "col--12")}>
<DocItemPaginator />
</div>
</div>
</div>
</div>
{docTOC.desktop && <div className="col col--3">{docTOC.desktop}</div>}
</div>
There was a problem hiding this comment.
Thanks! I caught it because of a visual regression testing tool, have you considered adding something like that to the demo, to catch small changes like this that are potentially easy to miss?
There was a problem hiding this comment.
I have - would you be willing to share your setup? I know Docusaurus uses Playwright + Argos, but I was hoping for something self-contained that can run entirely in GH Actions. Thanks!
There was a problem hiding this comment.
I have used Percy in the past and recently switched to using lost-pixel. I'm using their platform version via a github action (which is free for open source projects), but they also have a purely open-source self-hosted model available that would probably meet your needs from what I can tell.
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
Introduces support for latest Docusaurus, i.e. 3.5.0 - 3.5.2. Note that Docusaurus 3.5.0 moved
useDocandDocProviderwhich required changes that will not be backward compatible with prior Docusaurus versions.