* render math in README.org on github
@ 2024-12-20 17:20 Leo Butler
2024-12-20 18:10 ` Nikolaos Chatzikonstantinou
0 siblings, 1 reply; 4+ messages in thread
From: Leo Butler @ 2024-12-20 17:20 UTC (permalink / raw)
To: Org Mode Mailing List
Hello,
I am trying to use MathJax with a README.org file on github, but I am
having no luck. I believe that this "just works" with markdown on
github.
The best that I could find was a bug report by karthink [fn:1] that
refers to following instructions on a wiki. But, I can't find that wiki,
nor can I find any other advice that works. DuckDuckGo suggested an AI,
but that seems to be a source of infinitely many wrong guesses and about
as much frustration (it's like trying to get a straight answer out of a
C student).
Any pointers or tips would be appreciated.
TIA,
Leo
[fn:1] https://github.com/gollum/gollum/issues/1588
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: render math in README.org on github
2024-12-20 17:20 render math in README.org on github Leo Butler
@ 2024-12-20 18:10 ` Nikolaos Chatzikonstantinou
2024-12-20 18:51 ` Leo Butler
0 siblings, 1 reply; 4+ messages in thread
From: Nikolaos Chatzikonstantinou @ 2024-12-20 18:10 UTC (permalink / raw)
To: Leo Butler; +Cc: Org Mode Mailing List
[-- Attachment #1: Type: text/plain, Size: 1056 bytes --]
Do you want mathjax when viewing the readme file? If github is broken it is
on their end, they don't have the best coverage of org features.
Or do you want mathjax in the generated html in a github pages? That can be
done...
Another place that org doesn't work (at all) is pypi.
On Fri, Dec 20, 2024, 12:26 PM Leo Butler <Leo.Butler@umanitoba.ca> wrote:
> Hello,
>
> I am trying to use MathJax with a README.org file on github, but I am
> having no luck. I believe that this "just works" with markdown on
> github.
>
> The best that I could find was a bug report by karthink [fn:1] that
> refers to following instructions on a wiki. But, I can't find that wiki,
> nor can I find any other advice that works. DuckDuckGo suggested an AI,
> but that seems to be a source of infinitely many wrong guesses and about
> as much frustration (it's like trying to get a straight answer out of a
> C student).
>
> Any pointers or tips would be appreciated.
>
> TIA,
> Leo
>
> [fn:1] https://github.com/gollum/gollum/issues/1588
>
[-- Attachment #2: Type: text/html, Size: 1535 bytes --]
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: render math in README.org on github
2024-12-20 18:10 ` Nikolaos Chatzikonstantinou
@ 2024-12-20 18:51 ` Leo Butler
2024-12-21 12:53 ` Max Nikulin
0 siblings, 1 reply; 4+ messages in thread
From: Leo Butler @ 2024-12-20 18:51 UTC (permalink / raw)
To: Nikolaos Chatzikonstantinou; +Cc: Org Mode Mailing List
On Fri, Dec 20 2024, Nikolaos Chatzikonstantinou <nchatz314@gmail.com> wrote:
> Do you want mathjax when viewing the readme file?
Yes. The only documentation I have seen refers to markdown.
On a hunch, I changed all the math delimiters in my README.org to $ and
$$ and that worked. But, I would prefer to use the math delimiters \(\)
and \[\] and have that work.
> If github is broken it is on their end, they don't have the best
> coverage of org features.
I don't know enough about this to say what is broken. I am finding it
difficult to uncover good information about how things like this are
meant to work and how they can be configured.
Leo
>
> Or do you want mathjax in the generated html in a github pages? That can be
> done...
>
> Another place that org doesn't work (at all) is pypi.
>
> On Fri, Dec 20, 2024, 12:26 PM Leo Butler <Leo.Butler@umanitoba.ca> wrote:
>
>> Hello,
>>
>> I am trying to use MathJax with a README.org file on github, but I am
>> having no luck. I believe that this "just works" with markdown on
>> github.
>>
>> The best that I could find was a bug report by karthink [fn:1] that
>> refers to following instructions on a wiki. But, I can't find that wiki,
>> nor can I find any other advice that works. DuckDuckGo suggested an AI,
>> but that seems to be a source of infinitely many wrong guesses and about
>> as much frustration (it's like trying to get a straight answer out of a
>> C student).
>>
>> Any pointers or tips would be appreciated.
>>
>> TIA,
>> Leo
>>
>> [fn:1] https://github.com/gollum/gollum/issues/1588
>>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: render math in README.org on github
2024-12-20 18:51 ` Leo Butler
@ 2024-12-21 12:53 ` Max Nikulin
0 siblings, 0 replies; 4+ messages in thread
From: Max Nikulin @ 2024-12-21 12:53 UTC (permalink / raw)
To: emacs-orgmode; +Cc: Leo Butler
On 21/12/2024 01:51, Leo Butler wrote:
> On Fri, Dec 20 2024, Nikolaos Chatzikonstantinou wrote:
>
>> Do you want mathjax when viewing the readme file?
>
> Yes. The only documentation I have seen refers to markdown.
>
> On a hunch, I changed all the math delimiters in my README.org to $ and
> $$ and that worked. But, I would prefer to use the math delimiters \(\)
> and \[\] and have that work.
I suggest to be realistic and to adjust your expectations. There have
been no commits to <https://github.com/wallyqs/org-ruby> last years and
GitHub does not use the latest release.
Use a kind of Pidgin Org that is compatible with both org-ruby and
Emacs. If GitHub renders $...$ and $$...$$ then use it, despite they are
going to be deprecated in Org.
<https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions>
<https://github.blog/news-insights/product-news/math-support-in-markdown/>
You may try to file a bug against <https://github.com/github/markup/> or
some other project that really contains MathJax config to extend the
list of supported math delimiters for Org files.
>> If github is broken it is on their end, they don't have the best
>> coverage of org features.
GitHub and GitLab just use org-ruby gem, they do not develop it.
org-ruby is more close to regexps used for fontlock than to
org-element.el parser used for export. There are a lot of Org features
that are not recognized by org-ruby. In particular, org-ruby is unaware
of math (TeX) at all, it is just semi-transparent for this kind of
constructs.
And finally, GitHub performs security audit before update of deployed
gem version. Likely they will be reluctant to do it frequently pulling
changes from a fork.
>> On Fri, Dec 20, 2024, 12:26 PM Leo Butler wrote:
>>
>>> The best that I could find was a bug report by karthink [fn:1] that
>>> refers to following instructions on a wiki. But, I can't find that wiki
[...]
>>> [fn:1] https://github.com/gollum/gollum/issues/1588
See the description of the project and its wiki. As to specific
superscript issues, add
#+options: ^:nil
as a workaround.
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2024-12-21 13:43 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-12-20 17:20 render math in README.org on github Leo Butler
2024-12-20 18:10 ` Nikolaos Chatzikonstantinou
2024-12-20 18:51 ` Leo Butler
2024-12-21 12:53 ` Max Nikulin
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).