docs icon indicating copy to clipboard operation
docs copied to clipboard

Fenced block syntax for mathematical expressions inaccurate

Open mh105 opened this issue 3 years ago • 2 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions

What part(s) of the article would you like to see updated?

Alternatively, you can use the ```math code block syntax to display a math expression as a block. With this syntax, you don't need to use $$ delimiters.

Right now the doc says that fenced block syntax is available for math mode. However, upon testing, it seems that this syntax is only available on private repositories and not on public repositories. If this is indeed an intended distinction, the doc should make it clear and state that explicitly.

Additional information

This blog post from Github seems to suggest that this feature was intended for all markdown rendering. Unclear why it isn't enabled for public repositories.

mh105 avatar Oct 23 '22 17:10 mh105

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

welcome[bot] avatar Oct 23 '22 17:10 welcome[bot]

@mh105 Thanks so much for opening an issue! I'll triage this for the team to take a look :eyes:

cmwilson21 avatar Oct 24 '22 17:10 cmwilson21

Hi @mh105 - Thank you for opening this issue 💛 I looked into this and confirmed functionality and it turns out the math fence blocked syntax should function in public repos and now there's a PR open already to fix that bug. Thanks for bringing this to our attention!

dihydroJenoxide avatar Oct 26 '22 18:10 dihydroJenoxide