Style Guide#

This section is a place where I keep track of the style of the Notebook (very important to be consistent through the whole notebook).

a custom_css file is used to modify the titles.

Legend#

Notes#

Note

The note body will be hidden!

Warning

  • Here is a warning

Tip

This text is standard Markdown

Comments#

Comments are made for me to directly communicate with the reader.

Comment formatting

Questions: aimed at my supervisors or potential referees.
Basic notes: This is for me to highligt my thoughts during the writing process.
Important notes: Same as above but with an high importance level
Teaching notes: This is for me to "speak" to a potential tierce audience.

HTML Symbol#

Symbol list

Used#

  • βœ… - ticked box

  • ❌ - red cross

  • β†’ - right arrow

  • Ξ” - delta

  • ρ - rho

  • β‰Ί - inferior

  • 🌝 - happy emoji

Other intersting feature of JupyterBook#

Margin content#

The content on the right will be located in the margin

:figclass: margin
My_Space/Docs/M-X1178.png

Fig. 72 Mould X1178#

Panels#

There is ways to modify the formatting of the panel:

  • include link

Tables#

Best method to produce table is to use html. Here is a website to produce such html table:

  • Web-site

    • Copy/Paste html and css directly into the notebook.

    • Produce a .TGN file that can be loaded and modified.

Cards#

need the instalation of sphinx-design extension

Card header 1

Card 1 title

Card body 1

Card footer 1

One!

Here’s the first card.

Two!

Here’s the second card.

Three!

Here’s the third card.

Card caroussel#

card 1

content

card 2

Longer

content

card 3
card 4
card 5
card 6