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

docs: Fix \set documentation #3646

Merged
merged 3 commits into from Aug 28, 2022
Merged

docs: Fix \set documentation #3646

merged 3 commits into from Aug 28, 2022

Conversation

edemaine
Copy link
Member

@edemaine edemaine commented Jun 4, 2022

Work around | in tables

See facebook/docusaurus#2004

What is the previous behavior before this PR?

https://katex.org/docs/supported.html

image

image

Similarly in support table.

What is the new behavior after this PR?

image

image

Working around this bug was tricky. I had to \gdef\VERT{|} outside any table to make | effectively accessible within a Markdown table. This required making macros re-usable within docs, which may be useful in the future too.

@edemaine edemaine requested a review from ronkok June 4, 2022 20:50
@codecov
Copy link

codecov bot commented Jun 4, 2022

Codecov Report

Merging #3646 (02543f0) into main (8b4ba62) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #3646   +/-   ##
=======================================
  Coverage   92.98%   92.98%           
=======================================
  Files          90       90           
  Lines        6739     6739           
  Branches     1568     1568           
=======================================
  Hits         6266     6266           
  Misses        435      435           
  Partials       38       38           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8b4ba62...02543f0. Read the comment docs.

@edemaine edemaine requested review from kevinbarabash and removed request for kevinbarabash June 9, 2022 19:36
@edemaine
Copy link
Member Author

@ronkok Would you mind reviewing this small doc fix PR?

Copy link
Collaborator

@ronkok ronkok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Thank you for making this revision.

I wish that Markdown would accept grid tables similar to reStructuredText. That would make pipes easy to handle, in addition to other goodness.

@ronkok ronkok merged commit 7e6e9ee into main Aug 28, 2022
@ronkok ronkok deleted the set-docs branch August 28, 2022 17:18
@KaTeX-bot
Copy link
Member

🎉 This PR is included in version 0.16.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants