docs icon indicating copy to clipboard operation
docs copied to clipboard

Update writing-mathematical-expressions.md: Unsupported Math Blocks in <details> Blocks

Open alernety opened this issue 2 years ago • 4 comments
trafficstars

This issue is about displaying math blocks inside of the details blocks (and potentially other HTML blocks) regardless of the type of math block. This can include blocks such as

$$
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}
$$

or blocks written like this:

```math
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}
```

This issue is currently blocking the use of math blocks inside of details blocks, as well as other HTML blocks. This limitation prevents users from taking full advantage of these blocks, and should be noted in documentation. To ensure users are not held back, we must actively search for a potential solution to this issue so that math blocks can be displayed in these blocks.

Why:

Closes ISSUE

What's being changed (if available, include any code snippets, screenshots, or gifs):

code rendered

Check off the following:

  • [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [x] For content changes, I have completed the self-review checklist.

alernety avatar Jan 16 '23 10:01 alernety

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Jan 16 '23 10:01 welcome[bot]

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md fpt
ghec
ghes@ 3.7 3.6
fpt
ghec
ghes@ 3.7 3.6

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar Jan 16 '23 10:01 github-actions[bot]

This issue is about displaying math blocks inside of the details blocks (and potentially other HTML blocks) regardless of the type of math block. This can include blocks such as

$$
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}
$$

or blocks written like this:

```math
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}
```

This issue is currently blocking the use of math blocks inside of details blocks, as well as other HTML blocks. This limitation prevents users from taking full advantage of these blocks, and should be noted in documentation. To ensure users are not held back, we must actively search for a potential solution to this issue so that math blocks can be displayed in these blocks.

Why:

Closes ISSUE

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [ ] For content changes, I have completed the self-review checklist.

shango420 avatar Jan 16 '23 10:01 shango420

@ALernety Thanks so much for opening a PR! I'll get this triaged for review :zap:

cmwilson21 avatar Jan 17 '23 21:01 cmwilson21

Hi @ALernety, thanks for the PR! It appears to me that matrices render correctly IF you include a line of whitespace after the HTML tag.

For example,

<details>
<summary>Matrix</summary>

```math
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}
```

</details>

Appears to render correctly:

Matrix
\begin{pmatrix}
  0 & 1 \\
  2 & 3
\end{pmatrix}

I wonder if you could check whether this works for your use case too, and update your PR to reflect this if so? ✨

isaacmbrown avatar Jan 31 '23 12:01 isaacmbrown

It doesn't look like any updates have been on this for a while, so I'm going to go ahead and close it out 💛

Feel free to ping me here to reopen if it continues to be an issue.

cmwilson21 avatar Sep 05 '23 18:09 cmwilson21