Support columns on grid-item directive#2766
Open
stefanv wants to merge 6 commits intojupyter-book:mainfrom
Open
Support columns on grid-item directive#2766stefanv wants to merge 6 commits intojupyter-book:mainfrom
columns on grid-item directive#2766stefanv wants to merge 6 commits intojupyter-book:mainfrom
Conversation
- Pass through the `columns` option - Render `grid-item` as `grid-item` in AST, not as div
🦋 Changeset detectedLatest commit: 2c5cc33 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
choldgraf
approved these changes
Mar 16, 2026
Collaborator
choldgraf
left a comment
choldgraf
left a comment
There was a problem hiding this comment.
This LGTM - I think it's safe to merge when you're happy with it. A few quick non-blocking comments:
- Could we add minimal tests or warnings for the new functionality and the most common use-case bugs we expect users to accidentally trigger? e.g., what if columns is above 12 if a user thinks that might be possible?
- The confusion that triggered this was because there's a discrepancy between the functionality of the sphinx "grids" implementation and this one. Is there any other obvious thing we should add a brief warning for? Doesn't strictly need to be in this PR but it might be a nice opportunity to clear up confusion
| Grids allow you to structure arbitrary chunks of content in a grid-like system. | ||
|
|
||
| To generate a grid, use the ` ```{grid} ` wrapper directive along with ` ```{card} ` directives inside. | ||
| To generate a grid, use the `:::{grid} ...` wrapper directive along with `:::{grid-item}` or `:::{card}` directives inside. |
Collaborator
There was a problem hiding this comment.
sidenote: we should probably standardize this in our docs
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
3 participants
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.
columnsoptiongrid-itemasgrid-itemin AST, not as divxref: jupyter-book/myst-theme#838
closes: #1141
TODO: