Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📌 Update docs about grid breakpoints to reflect changes in theme #1819

Merged
merged 1 commit into from
Jan 28, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/dropdowns-cards-and-tabs.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ Card content

You can also add a `link` option to the card, which will allow you to make the entire card clickable:

````{myst}
```{myst}

:::{card} Clickable Card
:link: https://mystmd.org

The entire card can be clicked to navigate to `mystmd.org`.
:::
````
```

````{note} Compatibility with Sphinx design
:class: dropdown
Expand All @@ -76,6 +76,7 @@ Footer

Note that, card headers and footers are optional. If you don’t include ^^^ or +++ in your card, they will not show up.
````

:::{myst:directive} card
:::

Expand All @@ -90,6 +91,7 @@ A button is an element with text content that triggers an action to navigate to
```{myst}
{button}`MyST-MD GitHub <https://github.com/jupyter-book/mystmd>`
```

:::{myst:role} button
:::

Expand All @@ -99,7 +101,7 @@ 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.

The numbers supplied in the argument are column counts to be used on different screen sizes e.g. `1 1 2 3` corresponding to extra-small (<576px), small (768px), medium (992px) and large screens (>1200px).
The numbers supplied in the argument are column counts to be used on different screen sizes e.g. `1 1 2 3` corresponding to smallest (<768px), medium (768px – 1024px), large (1024px – 1280px), and extra-large screens (>1280px). These pixel widths are determined by the theme (e.g. the book theme), which uses the default Tailwind CSS breakpoints.

For example:

Expand Down
Loading