Skip to content

Rendering math equations? #897

Closed
Closed

Description

@IreneCrisologo

Hi folks,
Any updates on this? Rendering math on README pages would be very very helpful.

I know it can be done using online tools like iTex2Img but it would be easier if the normal latex expressions can be digested.

Thanks a bunch!
-i

Activity

  1. adavidzh commented on Jun 29, 2016

    @adavidzh

    Also #274 was asking to go in this direction. No chance to have a supported way to render math in github README files?

  2. jayvdb commented on Jul 1, 2016

    @jayvdb

    I've been doing a little analysis on imsky/PocketEuler#44

    One simple and secure approach is to use the small mimetex (code mirrorred at https://github.com/icaoberg/mimetex) , which is a standalone renderrer, not using any other larger binaries like latex.

    https://packages.debian.org/search?suite=jessie&searchon=names&keywords=mimetex
    https://admin.fedoraproject.org/pkgdb/package/rpms/mimetex/

    No CVE since 20090713, which a batch of problems was found. See also https://www.debian.org/security/2009/dsa-1917.en.html

    Another approach is the use the MediaWiki approach, which is also battle tested, of texvccheck/texvc , an OCaml program , which has a small checker program (texvccheck) that checks the AMS-Latex before sending to a second program that using latex to render it.

    0 CVE : https://cve.mitre.org/cgi-bin/cvekey.cgi?keyword=texvc

  3. jayvdb commented on Jul 1, 2016

    @jayvdb

    @bkeepers , you closed #274 saying "can't be resolved by a change to the code in this project".

    So, which project(s) should this feature be added to? Each of the processors? Or a new project to do that math rendering only?

    Most people are interested in maths in markdown , which is https://github.com/vmg/redcarpet , but they have rejected that feature request : vmg/redcarpet#313 and a smaller version of it vmg/redcarpet#395

    RST and docutils supports maths, but this has been disabled #83

    asciidoctor supports MathJax (asciidoctor/asciidoctor#492) , but without MathJax JS loaded by github markup it wont work. And there is https://github.com/asciidoctor/asciidoctor-latex

    mediawiki has <math> and wikicloth has supported it since 2011 (nricciar/wikicloth#19 / https://github.com/nricciar/wikicloth/blob/master/lib/wikicloth/extensions/math.rb) , but again it isnt enabled by github markup.

    Is there a plan? What is the plan? What do you need? How can we help?

  4. jayvdb commented on Jul 5, 2016

    @jayvdb

    Note related request for MathML : #551

  5. jayvdb commented on Jul 10, 2016

    @jayvdb

    Maybe a first step is for Github to treat typical math mode as non-markdown mode, similar to backticks (..).

    Currently Github renders

    Let $\text{S}_1(N) = \sum_{p=1}^N \text{E}(p)$

    with the _ denoting italics, as

    "Let $\text{S}1(N) = \sum{p=1}^N \text{E}(p)$"

    The same thing happens with *.

  6. AaronNGray commented on Jul 10, 2016

    @AaronNGray

    @bkeepers I have found a stop gap solution a site https://www.codecogs.com/latex/eqneditor.php that generates embedded links with TeX editor that then embeds a gif in GitHub :-

    double click on the equation to be taken to the editor ;)

  7. adavidzh commented on Jul 10, 2016

    @adavidzh

    Hey @AaronNGray, that is pretty nifty!

  8. adavidzh commented on Jul 10, 2016

    @adavidzh

    I'm wondering if the codecogs workaround of @AaronNGray could be packaged with github.io+MathJax?

  9. AaronNGray commented on Jul 10, 2016

    @AaronNGray

    It would be very easy to make a similar webapp to codecogs https://www.codecogs.com/latex/eqneditor.php. This would give the security isolation that GitHub needs by having it as a separate web based application.

    It would be useful to attach persistant URL's to equations and use them for accessing the images and the editor rather than the long URL's codecogs uses.

    Also codecogs does not support many packages. It does not support the 'semantic' and 'maths-symbols' that I need in order to make this useful and I am sure others will want other packages.

    https://www.ctan.org/tex-archive/macros/latex/contrib/semantic
    https://www.ctan.org/pkg/maths-symbols

    The following should come out as an inference rule :-

    and codecogs does not support \usepackage{}

  10. AaronNGray commented on Jul 10, 2016

    @AaronNGray

    I am putting together a Node.js solution for this.

  11. taiya commented on Jul 31, 2016

    @taiya

    I taught that GitHub originally had MathJax on his pages, later on removed it to make sure everything was nice and responsive. Why would it be so difficult to have a "preview" button that enables mathjax on demand? Wikipedia seems to be doing math, yet maintain responsiveness, just fine!

  12. FlorianFranzen commented on Aug 1, 2016

    @FlorianFranzen

    +1

  13. allefeld commented on Aug 7, 2016

    @allefeld

    How about opt-in MathJax on a per-repository basis? General GitHub responsiveness would not be impaired, but simple math would be there for people who need it.

  14. taiya commented on Aug 7, 2016

    @taiya

    @allefeld anything really, but removing it cold-turkey creates a big problem.
    Basically any mathematical software cannot use the wiki to document the software :(

  15. AaronNGray commented on Aug 7, 2016

    @AaronNGray

    I will see if I can get a third party TeX based solution in place ASAP. I got distracted trying to get Angular2 working in order to do the UI.

  16. 48 remaining items

  17. nihonjinrxs commented on Jun 15, 2017

    @nihonjinrxs

    This issue is definitely important, and it's really painful not to have support for equations.

    Image based workarounds are clunky at best, hard to edit, and generally don't meet accessibility requirements, which are a legal mandate for all publicly funded universities in the US.

    Individual browser plugin based workarounds don't help because they don't allow for someone else looking at the repo who doesn't have the plugin installed.

    Native support is needed here.

    If not this repo, then where? If it's code I can get to, I'm happy to work on it and do a PR if needed, but I'd want to know you all would merge once done before I dedicate the time. Let me know.

  18. johndpope commented on Jun 29, 2017

    @johndpope

    Well - some good news - thanks to @goessner - and his markdown math plugin for Visual studio code - you can write / read maths equations quite elegantly by the look of it
    https://marketplace.visualstudio.com/items?itemName=goessner.mdmath

    Dear Github - please roll out Markdown maths in gists.
    https://github.com/goessner/mdmath

  19. johndpope commented on Jun 30, 2017

    @johndpope

    I think taking a leaf out of wikipedia's book -
    they do both - they have support for latex maths equations - and spit out an image with the 'alt' / text alternative markup allowing editors to update / edit / copy and paste.

    screen shot 2017-06-30 at 15 57 29

    for anyone using Chrome extension - you may want to check out
    Alt Text Tester (where you can double click to copy latex ) - https://chrome.google.com/webstore/detail/alt-text-tester/koldhcllpbdfcdpfpbldbicbgddglodk

    there is also this chrome plugin to spit out images of maths equations https://chrome.google.com/webstore/detail/equatio-math-made-digital/hjngolefdpdnooamgdldlkjgmdcmcjnc

    screen shot 2017-07-01 at 15 52 22

  20. milasudril commented on Jul 1, 2017

    @milasudril

    However, native mml should be supported as well. Wikipedia doesn't.

  21. AaronNGray commented on Jul 1, 2017

    @AaronNGray
  22. milasudril commented on Jul 1, 2017

    @milasudril

    Well here is a status report on that statement. There are four main browsers: Blink (WebKit fork for Chrome?), Edge, Gecko and WebKit. Gecko has complete MathML support and WebKit has experimental support. Safari (WebKit based) has it from 10.1. See also http://caniuse.com/#search=mathml. The Chrome and Edge teams have no plans to support it.

    Then one can observe that XML is PITA and TeX is nice (from a user point of view, see https://groups.google.com/forum/#!topic/mozilla.dev.platform/96dZw1jXTvM). But the important thing here is that there should be a way of displaying formulas natively, without falling back to images. For Gecko, MathML is the way of doing it, while the other engines has no stable way.

    Another point is that not all users are Pro(tm) users. If Chrome and Edge targets a consumer grade product, you may claim that math support is not needed. This is fine as long as there are browsers Pro(tm) users. Actually, one of the main reasons I use Firefox over Chrom* is that it supports math natively.

  23. AaronNGray commented on Jul 1, 2017

    @AaronNGray
  24. eyalroz commented on Jul 1, 2017

    @eyalroz

    @milasudril , @AaronNGray : Shouldn't this discussion separate the markup users enter when editing and the result of rendering the markup? I mean, as far as the result is concerned, it could be MathML for WebKit and Gecko, and images for Edge and Blink. And as for the markup - that can be chosen half-independently and certainly does not depend on which browser you use.

  25. milasudril commented on Jul 2, 2017

    @milasudril

    @eyalroz That was the implied meaning of

    But the important thing here is that there should be a way of displaying formulas natively, without falling back to images. For Gecko, MathML is the way of doing it, while the other engines has no stable way.

  26. andy-shev commented on Jul 10, 2017

    @andy-shev

    GitHub has good expertise in storage are and bad one in math apparently. Guys, it's not a way how to help users. Math formulas are tighten to the software more than you (probably) think.

  27. RoyiAvital commented on Jul 11, 2017

    @RoyiAvital

    Any chance to make GitHub reconsider this?

    Today many of the codes in GitHub deals with Data Analysis and Math documentation is essential for that.
    Please reconsider.

  28. FlorianFranzen commented on Jul 11, 2017

    @FlorianFranzen

    @kivikakk Since you have not replied by now, I assuming your decision is final. Gitlab it is.

  29. sachinruk commented on Sep 1, 2017

    @sachinruk

    ping. Any update on this? I dont think anyone has given up on wanting math equations on their README's.

  30. kivikakk commented on Sep 1, 2017

    @kivikakk
    Contributor

    I'll repeat my last point — this repository is not for feature requests. It's a gem for delegating markup rendering.

    Rendering math inline in e.g. Markdown is not a github-markup issue. You're welcome to reach out to the support team with further questions and suggestions about it, but please note that Markup does one specific thing — delegate rendering to gems — and rendering math inline in blobs happens elsewhere.

    If you comment here, you don't reach the support team who can then direct your query appropriately, you reach me, and I'm not the person who decides what we implement in the GitHub product.

  31. locked and limited conversation to collaborators on Sep 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions