Skip to article frontmatterSkip to article content

equations and dollarmath

this requires extra config, search for dollarmath

same for latex-math inline xC\forall x\in \mathbb{C} like this,
or double-dollars like that

xC\forall x\in \mathbb{C}

or with a {math} directive

yR\exists y \in \mathbb{R}

strikethrough

pure markdown with double tildes

~~so that one can see text in strikethrough mode~~

it renders as : ~~so that one can see text in strikethrough mode~~

well this one is a bit disappointing, no longer works in either jlab or mystmd as of 2025 march.. (it used to require an extra step in the sphinx config)

with a MyST role

note that one can also use a MyST role, and that now works in both jlab and mystmd

{strike}`so that one can see text in strikethrough mode`

it renders: so that one can see text in strikethrough mode

NOTE for striking a piece of text, we can use

{del}`` `a piece of text` ``

which renders as a piece of text

not quite sure about the del vs strike thing though

the MyST download role

mostly we use this to create a link to download an exercise as a zip -- heavily used in flotpython-exos

{download}`commencez par télécharger le zip<./downloadable.zip>`

commencez par télécharger le zip

execute and insert: the eval role

looking into this to customize the README’s of the 2 exos flavours
however that won’t work in jupyter book, so ...
it does work in jlab though, in case it become useful some day (although it sometimes take 2 evaluations to show up right)

value = "Data Science"

with this syntax

{eval}`value`

we get: today we will learn Data Science

# a little painful, but we can't seem to do the import inside the markdown eval
# because it only works on expressions 
import os

admitting that the USER environment variable is set, we can also insert its value:

in a title we get the user id as runner