Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 

README.md

Markdown-LaTeX

This is a Python script that looks for a README written with Markdown + equation and outputs a README.md with the equation equations replaced by images rendered by CodeCogs.

You can use it with other Markdown files, just pass the path to them as an argument to the script:

python insert_equations.py [MARKDOWN_FILE_PATH]

How to write the equations

To type the equations in the original document, just put them between double dolar signs ($).

As an example, this is a README.md generated by the README in this repo using that script, so we can type things like this:

equation.

Now compare the README and the raw version of this README.md.

That's a simple way to write equations here in Github.

Have equation!

About

Take a Markdown file with LaTeX equations between $$ signs and outputs a Markdown with the equations replaced by images rendered by CodeCog.

Resources

License

Releases

No releases published

Languages

You can’t perform that action at this time.