Skip to content

chrismilson/github-math

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This project was bootstrapped with Create React App, and uses the ace-editor.

Github Math

Have you ever had trouble expressing mathematical ideas in a Github readme?

Have you ever become tired of typing ⁄, ⌊ or ∈?

Well, don't you fret! Github has basic LaTeX style math encoding ability, and this app will streamline the process of going from something like x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a} to x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a} in no time.

Usage

  1. Open the app.

  2. Enter some mathematics.

  3. Get the url. This is what github uses to generate your image. You can do this by clicking the preview image.

  4. Use the url as the source for an image.

Examples

Standalone

The sigmoid function, g, is defined on complex numbers z as:

![sigmoid](https://render.githubusercontent.com/render/math?math=g(z) = \frac{1}{1 + e^{-z}})

The sigmoid function, g, is defined on complex numbers z as:

sigmoid

Inline

It can also be used inline:

A **simple function** on
![the reals](https://render.githubusercontent.com/render/math?math=\mathbb{R})
is a measurable function
![phi](https://render.githubusercontent.com/render/math?math=\varphi:\mathbb{R}\to\mathbb{R})
such that
![the domain of phi](https://render.githubusercontent.com/render/math?math=\varphi(\mathbb{R}))
is finite.

A simple function on the reals is a measurable function phi such that the domain of phi is finite.