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

Bug or missing documentation for LaTex code when MD markup conflicts #137

Open
fgiasson opened this issue Dec 15, 2014 · 1 comment
Open

Comments

@fgiasson
Copy link
Contributor

In some cases, there is a conflict between LaTeX markup and MD's. An example is:

\\(C_{1},...,C_{j}\\)

If you use that LaTeX code in your comment, then it won't be managed by MathJax. The issue is that Marginalia is parsing the LaTeX code within the LaTeX code and will add the <em>...</em> markup which will render MathJax nonoperational.

To fix that, you have to single escape the MD markup like this:

\\(C\_{1},...,C\_{j}\\)

And that will work.

However:

  1. this will only work in comments, not in docstrings.
  2. if you try that code in docstring, you will get a compilation error since it is single escaped (would need to be double escaped)

Could this kind of usecases be handled directly in Marginalia before processing the MD code?

@abrooks
Copy link

abrooks commented Sep 8, 2015

This was an issue for me as well. I'd have appreciated the above documentation that @fgiasson provided in the html.clj documentation.

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

No branches or pull requests

2 participants