commutative diagrams in doc-gen

Stream: general

[Yury G. Kudryashov]

Hi, how do we type commutative diagrams in API docs? What styles are supported (if any)? amscd? xypic? tikz? I'm looking at docs#dense_inducing.tendsto_comap_nhds_nhds

[Kevin Buzzard]

Are you saying you don't like γ -f→ α g↓ ↓e δ -h→ β? Hmm, you are right: it does look better in the source.

[Alex J. Best]

The site uses mathjax3 so I guess amscd would work

[Matthew Ballard]

If not, katex supports it

[Matthew Ballard]

TikzJax also exists but renders slowly in my experience

[Matthew Ballard]

Admittedly, these last two address what is possible rather than what is currently supported. But amscd is your best bet

[Patrick Massot]

I think we are simply hitting the limit of what browser rendering of tex can do here. Rather than necromancing amscd we should rather switch to server-side rendering of a png (here servver-side means doc-gen side).

[Matthew Ballard]

Yes, I agree server side is the correct choice the majority of the time.

[Eric Wieser]

I think mathjax can be prerendered, which still has the advantage of being searchable unlike an image

[Patrick Massot]

You can prerender mathjax for what mathjax can render, and a SVG image for what it cannot

[Eric Wieser]

Kevin Buzzard said:

Are you saying you don't like γ -f→ α g↓ ↓e δ -h→ β? Hmm, you are right: it does look better in the source.

The source would work just fine if the author remembered to include ``` around it

[Patrick Massot]

This was written long before it made sense to put any backquote in Lean comments.

[Yakov Pechersky]

A recent github blog post seems relevant: https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/