Markdown Jupyter Notebook



Jupyter Book uses MathJax for typesetting math in your HTML book build.This allows you to have LaTeX-style mathematics in your online content.This page shows you a few ways to control this.

  • If your notebook contains more text than code, if you are writing a documentation or a book, you probably want to save your notebook as a Markdown document Use the Jupytext Markdown format if you wish to render your notebook as a.md file (without its outputs) on GitHub.
  • “Text can be added to Jupyter Notebooks using Markdown cells. You can change the cell type to Markdown by using the Cell menu, the toolbar, or the key shortcut m.Markdown is a popular markup language that is a superset of HTML.

“Text can be added to Jupyter Notebooks using Markdown cells. You can change the cell type to Markdown by using the Cell menu, the toolbar, or the key shortcut m. Markdown is a popular markup language that is a superset of HTML. Its specification can be found here:n”, “n”, “”. Jupyter (formerly IPython Notebook) is an open-source project that lets you easily combine Markdown text and executable Python source code on one canvas called a notebook. Visual Studio Code supports working with Jupyter Notebooks natively, as well as through Python code files. Jupyter Notebook supports Markdown. This lesson will cover some of the things you can do using Markdown to interlace your thoughts and code in Notebooks to tell compelling stories about your data. You’ll see how to format text, add syntax highlighting, make lists, and other ways to make text presentable.

See also

For more information about equation numbering,see the MathJax equation numbering documentation.

Tip

Notebook

By default MathJax version 2 is currently used.If you are using a lot of math, you may want to try using version 3, which claims to improve load speeds by 60 - 80%:

See the Sphinx documentation for details.

In-line math¶

Anaconda Download

To insert in-line math use the $ symbol within a Markdown cell.For example, the text $this_{is}^{inline}$ will produce: (this_{is}^{inline}).

Math blocks¶

You can also include math blocks for separate equations. This allows you to focus attentionon more complex or longer equations, as well as link to them in your pages. To use a blockequation, wrap the equation in either $$ or begin statements.

For example,

results in:

[ int_0^infty frac{x^3}{e^x-1},dx = frac{pi^4}{15}]

Latex-style math¶

You can enable parsing LaTeX-style math blocks with the amsmath MyST extension. Enable it by adding the following to _config.yml

Markdown Jupyter Notebook

Once enabled, you can define math blocks like so:

Markdown

which results in:

[begin{gather*}a_1=b_1+c_1a_2=b_2+c_2-d_2+e_2end{gather*}]
(2)¶[begin{align}a_{11}& =b_{11}& a_{12}& =b_{12}a_{21}& =b_{21}& a_{22}& =b_{22}+c_{22}end{align}]

See also

The MyST guides to dollar math syntax, LaTeX math syntax, and how MyST-Parser works with MathJax.

For advanced use, also see how to define MathJax TeX Macros.

Numbering equations¶

If you’d like to number equations so that you can refer to them later, use the math directive.It looks like this:

For example, the following code:

will generate

(3)¶[w_{t+1} = (1 + r_{t+1}) s(w_t) + y_{t+1}]
Markdown Jupyter NotebookMarkdown Jupyter Notebook

Alternatively you can use the dollar math syntax with a prefixed label:

which generates

(4)¶[ w_{t+1} = (1 + r_{t+1}) s(w_t) + y_{t+1}]

Note

Labels cannot start with an integer, or they won’t be able to be referenced andwill throw a warning message if referenced. For example, :label:1 and :label:1eq cannotbe referenced.

Linking to equations¶

If you have created an equation with a label, you can link to it from within your text(and across pages!).

You can refer to the equation using the label that you’ve provided by usingthe {eq} role. For example:

results in

Jupyter Notebook Markdown Font Size

  • A link to an equation directive: (3)

  • A link to a dollar math block: (4)

Note

Markdown Jupyter Notebook Bold

labels inside LaTeX environment are not currently identified, and so cannot be referenced.We hope to implement this in a future update (see executablebooks/MyST-Parser#202)!