If the README has an rmd or Rmd extension, the README is first knitted using knit(rmd) and then the resultant md file is used. You must put in a README file as the rmd argument. Let's see it's arguments: args(parse_latex) It's not the best function name for what it does, but I don't really care. You would then load the package: library(latexreadme) Install_github("muschellij2/latexreadme")
#MARKDOWN MATH INSTALL#
You can install the package using: library(devtools) I wrote an R package that would parse a README.md (or README.rmd if it's RMarkdown). I didn't allow options for putting them in a sub-folder, but may incorporate that.
This only works for inline equations marked with dollar signs ($) or equations marked by double dollar signs ($$).I have done a bit of parsing in the past, but I was either too lazy to think about the right regex to do, couldn't think of it easily, or thought my solution was sufficient even if not elegant. I opted to try a more generic solution for (4.) using some very hackey text parsing. Use LaTeXIt (for Mac OS) or other converter to make your equations and embed them.These are good options, but 1) they may go away at any time, and 2) require you to rewrite your md file. GitHub parsing is done by SunDown and is secure, therefore won't do LaTeX. It cannot (and in some cases, shouldn't) be done.Apparently, many others ( 1, 2, 3 ), have asked the same question. I have many times wondered about getting LaTeX math to render in a README file on GitHub.
The Problem: GitHub README.md won't render LaTeX
0 kommentar(er)
