Tests of Jupyter Book features

Click the .md button under the download icon on the top middle right to see the markdown code for this section. The file theme.css has color assignments and the like. Customize? (See https://jupyterbook.org/advanced/html.html#custom-assets)

colon_fence

To allow you to use ::: fences for admonitions, in order to make them easier to render in interfaces that do not support MyST.

Important

Note

This text is standard Markdown. We’re using the “colon_fence” extension.

replacements

Test of “replacements” extension: ®, ® en-dash: – and em-dash: —

Trying “linkify” extension: google.com

substitutions

Inline: I’m a substitution

Block level:

Note

I’m a substitution

col1	col2
Note I’m a substitution

definition lists

Term 1

Definition

Term 2

Definition

images

Now for some text in between.

Fig. 1 This is a caption in Markdown

Go to the fish!

videos

HTML admonitions

This is the title

This is the content of an admonition.

Note

Some content

A title

Paragraph 1

Paragraph 2

Customized admonitions

Extra credit

An “extra credit” exercise is presented here.

An extra exercise

An “extra credit” exercise is presented here. The css doesn’t work yet.

This is a title

An example of an admonition with a title and a warning style.

Dropdown answer

The old hidden fish trick!

Some hidden toggle content!

Maybe this needs to be in an .ipynb file?

Question

The matrix product of 2 rank 2 tensors

Answer

First answer is: \( a_{ij} b_{jk} = c_{ik} \)

Let’s try again here.

Answer

()\[\begin{equation} \mbox{Second answer is:}\quad a_{ij} b_{j} = c_{i} \end{equation}\]

Spread things out a bit.

Click the button to reveal!

Some hidden toggle content!

Different admonitions: note, warning, tip, caution, attention, danger, error, hint, important

Note

Notes require no arguments, so content can start here.

Warning

This is an example of a warning directive.

Tip

This is an example of a tip directive.

Attention

This is an example of an attention directive.

Danger

This is an example of a danger directive.

Error

This is an example of an error directive.

Hint

This is an example of a hint directive.

Important

This is an example of an important directive.

Grids

“Grids allow you to structure arbitrary chunks of content in a grid-like system. You can also control things like the width of columns, the “gutters” between columns, etc.”

A

B

C

D

“You can control how many columns are in each grid item with the :columns: option. Grids are split into 12 units of length, and this can be used to split up items as you wish. For example:”

A

B

C

D

“There is a short-hand for adding grids made up of cards, by using the {grid-item-card} directive. For example:””

One!

Here’s the first card.

Two!

Here’s the second card.

Three!

Here’s the third card.

More dropdowns

Here’s my dropdown

And here’s my dropdown content

Turning an admonition into a dropdown (see above as well):

Note

The note body will be hidden!

::::{admonition} Question
What is the pdf $p(x)$ if we know **definitely** that $x = x_0$ (i.e., fixed)?
:::{admonition} Answer 
:class: dropdown 
$p(x) = \delta(x-x_0)\quad$  [Note that $p(x)$ is normalized.]
:::
::::

Footnotes

You can include footnotes in your book using standard Markdown syntax. This will include a numbered reference to the footnote in-line, and append the footnote to a list of footnotes at the bottom of the page.

To create a footnote, first insert a reference in-line with this syntax (look at the markdown for how this plays out): [1].

You can define [1] anywhere in the page, though its definition will always be placed at the bottom of your built page.

Quotations and epigraphs

Standard markdown first:

Here is a cool quotation.

From me, Jo the Jovyan

Now with the epigraph admonition. (Epigraphs draw more attention to a quote and highlight its author. You should keep these relatively short so that they don’t take up too much vertical space.)

Here is a cool quotation.

—Jo the Jovyan

Glossaries

Term one

An indented explanation of term 1

A second term

An indented explanation of term2

To reference terms in your glossary, use the {term} role. For example, Term one becomes Term one and A second term becomes A second term.

Tabbed content

Tab 1 title

My first tab

Tab 2 title

My second tab with some code!

This can be used to show off many different view of the same content, such as providing multiple language examples. For example:

c++

int main(const int argc, const char **argv) {
  return 0;
}

python

def main():
    return

java

class Main {
    public static void main(String[] args) {
    }
}

julia

function main()
end

fortran

PROGRAM main
END PROGRAM main

Learn more about tabs

See the sphinx-design tabs documentation for more information on how to use this.

Margin and sidebar content

My margin title

Here is my margin content, it is pretty cool!

You can specify content that should exist in the right margin. This will behave like a regular sidebar until the screen hits a certain width, at which point this content will “pop out” to the right white space. Put the margin syntax at the start of the paragraph you want to add margin content to.

My sidebar title

Here is my sidebar content, it is pretty cool!

Content sidebars exist in-line with your text, but allow the rest of the page to flow around them, rather than moving to the right margin. As with the margin notes, put the sidebar syntax at the start of the paragraph that will wrap around the sidebar. Note how the content wraps around the sidebar to the right. However, the sidebar text will still be in line with your content. There are certain kinds of elements, such as “note” blocks and code cells, that may clash with your sidebar. If this happens, try using a {margin} instead.

---

[1] (1,2)

My footnote text.