Markdown Files

Whether you write your book’s content in Jupyter Notebooks (.ipynb) or in regular markdown files (.md), you’ll write in the same flavor of markdown called MyST Markdown. This is a simple file to help you get started and show off some syntax.

What is MyST?

MyST stands for “Markedly Structured Text”. It is a slight variation on a flavor of markdown called “CommonMark” markdown, with small syntax extensions to allow you to write roles and directives in the Sphinx ecosystem.

For more about MyST, see the MyST Markdown Overview.

Sample Roles and Directives

Roles and directives are two of the most powerful tools in Jupyter Book. They are kind of like functions, but written in a markup language. They both serve a similar purpose, but roles are written in one line, whereas directives span many lines. They both accept different kinds of inputs, and what they do with those inputs depends on the specific role or directive that is being called.

Here is a “note” directive:

Note

Here is a note

It will be rendered in a special box when you build your book.

Here is an inline directive to refer to a document: Notebooks with MyST Markdown.

Citations

You can also cite references that are stored in a bibtex file. For example, the following syntax: {cite}`holdgraf_evidence_2014` will render like this: [].

Moreover, you can insert a bibliography into your page with this syntax: The {bibliography} directive must be used for all the {cite} roles to render properly. For example, if the references for your book are stored in references.bib, then the bibliography is inserted with:

CFG87

Ralph H. Colby, Lewis J. Fetters, and William W. Graessley. The melt viscosity-molecular weight relationship for linear polymers. Macromolecules, 20(9):2226–2237, 1987. URL: https://doi.org/10.1021/ma00175a030, arXiv:https://doi.org/10.1021/ma00175a030, doi:10.1021/ma00175a030.

Har99

C. A. Harper, editor. Modern Plastics Handbook. McGraw-Hill, 1999.

KJC94

J. L. Keddie, R. A. L. Jones, and R. A. Cory. Size-Dependent Depression of the Glass Transition Temperature in Polymer Films. EPL (Europhysics Letters), 27(1):59, jul 1994. URL: https://iopscience.iop.org/article/10.1209/0295-5075/27/1/011 https://iopscience.iop.org/article/10.1209/0295-5075/27/1/011/meta, doi:10.1209/0295-5075/27/1/011.

LC08

M. Paula Longinotti and Horacio R. Corti. Viscosity of concentrated sucrose and trehalose aqueous solutions including the supercooled regime. Journal of Physical and Chemical Reference Data, 37(3):1503, jul 2008. URL: https://aip.scitation.org/doi/abs/10.1063/1.2932114, doi:10.1063/1.2932114.

Rub03

Michael Rubinstein. Polymer physics. Oxford University Press, Oxford ; New York, N.Y., 2003. ISBN 9780198520597.

Sad14

Martin H. (Martin Howard) Sadd. Elasticity : theory, applications, and numerics. Elsevier, Amsterdam, third edition. edition, 2014. ISBN 0-12-410432-0.

Sch95

J. E.K. Schawe. Principles for the interpretation of modulated temperature DSC measurements. Part 1. Glass transition. Thermochimica Acta, 261(C):183–194, sep 1995. doi:10.1016/0040-6031(95)02315-S.

SNST80

Shao‐Tang Sun, Izumi Nishio, Gerald Swislow, and Toyoichi Tanaka. The coil–globule transition: radius of gyration of polystyrene in cyclohexane. The Journal of Chemical Physics, 73(12):5971–5975, 1980. URL: https://doi.org/10.1063/1.440156, arXiv:https://doi.org/10.1063/1.440156, doi:10.1063/1.440156.

BeaucageSteinHashimotoHasegawa91

G. Beaucage, R. S. Stein, T. Hashimoto, and H. Hasegawa. Tacticity effects on polymer blend miscability. Macromolecules, 24(11):3443 – 3448, 1991.

MinPaul03

K. E. Min and D. R. Paul. Effect of tacticity on permeation properties of poly(methyl methacrylate). J. Poly. Sci. B. Poly. Phys., 26(5):1021 – 1033, 2003.

PaukkeriLehtinen93

R. Paukkeri and A. Lehtinen. Thermal behaviour of polypropylene fractions: 1. Influence of tacticity and molecular weight on crystallization and melting behaviour. Polymer, 34(19):4075 – 4082, 1993.

VorenkamptBrinkeMeijer+85

E. J. Vorenkamp, G. ten Brinke, J. G. Meijer, H. Jager, and G. Challa. Influence of the tacticity of poly(methyl methacrylate) on the miscability with poly(vinyl chloride). Polymer, 26(11):1725 – 1732, 1985.

WashburnLauterbachSnively06

S. Washburn, J. Lauterbach, and C. M. Snively. Polymerization of Unpolymerizable Molecules through Topological Control. Macromolecules, 39(24):8210 – 8212, 2006.

Learn more

This is just a simple starter to get you started. You can learn a lot more at jupyterbook.org.