Skip to content

mienkoja/textormd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

textormd

NOTE: This Function Has Not Been Well-Tested

For individuals who are willing (or seeking) to edit github wikis from RStudio and wishing to add typeset math into the entries, textormd() is an R function for use with the knitr package from @yihui.

This function is an admittedly hackish workaround for the issue described here, here, here, and here.

The entry in the wiki of this repo is the result of a markdown document generated from the knit2html() function available within knitr (as implemented in the RStudio IDE). As can be seen, the textormd() function can be used in conjunction with the knitr package to yield type set math text within the GitHub wiki environment.

The function makes use of the mathtex web service described in more detail here. Using the textormd() function, users should be able to

  1. Enter mathtex commands either inline or in code chunks within an R Markdown document as shown [here](A link to the raw Rmd file is available here,

  2. Compile that document to html (with keep_md: yes set in the preamble),

  3. PUSH the resulting markdown file and associated images to a wiki for a given repository (see the following link for information on how to edit a wiki locally), and

  4. View all of the figures and mathtex images the wiki (or perhaps in the README) as shown here.

NOTE: A Double slash "\" is required for all mathtex functions.

I don't intend for this to be a long-term solution. Just something to get me (or others) by until GitHub starts to support equation rendering again.

About

A workaround for individuals willing (or seeking) to edit github wikis from RStudio and wishing to add typeset math into the entries.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages