From 44972b3587004c913e734c0b8ee50778ad9e72f8 Mon Sep 17 00:00:00 2001 From: Freek Pols Date: Thu, 13 Jun 2024 10:13:12 +0200 Subject: [PATCH] edits to reference --- book/basic-features/References.md | 19 ++++++++++++++++++- book/basic-features/equations.md | 6 ++++++ book/basic-features/jupyterbook.md | 15 ++++++++++++++- 3 files changed, 38 insertions(+), 2 deletions(-) diff --git a/book/basic-features/References.md b/book/basic-features/References.md index d48c47c..8ead841 100644 --- a/book/basic-features/References.md +++ b/book/basic-features/References.md @@ -2,6 +2,23 @@ To make references to figures, equations et cetera, use the following syntax: -- For figures, use: ``{numref}`` `` +- For figures, use: ``{numref}`Figure {number} ` `` - For equations, use: ``{eq}`` `` - For citations, use: ``{cite:p}`` `` for a citation between parenthesis, or ``{cite:t}`` `` for an inline citation. + +**Examples** + +As can be seen in ``{numref}`Figure {number} ` `` (result) {numref}`Figure {number} `, not related to {eq}`` + +```{figure} ../images/git-push.png +--- +width: 50% +name: fig-gitpush +--- +Some caption here +``` + +$$ F = m\cdot a $$(eq:Newton) + + + diff --git a/book/basic-features/equations.md b/book/basic-features/equations.md index 5e680ce..7a08943 100644 --- a/book/basic-features/equations.md +++ b/book/basic-features/equations.md @@ -24,6 +24,12 @@ To number the equations and refer in text, you need to provide a label to the eq F = m \cdot a $$ (newtons_second_law) +Resulting in: + +$$ + F = m \cdot a +$$ (newtons_second_law) + > **Note** > > The Jupyter Book uses MathJax to display equations, which provides some LaTeX-like functionality, but not all! For example, the Euro symbol is missing, and packages like `siunitx` are not available (hint, use `\textrm{}` and `\textrm{}`). When something is not working, it's useful to search for MathJax-specific solutions (hint, include "mathjax" in your Google search). diff --git a/book/basic-features/jupyterbook.md b/book/basic-features/jupyterbook.md index 2186618..047b3d7 100644 --- a/book/basic-features/jupyterbook.md +++ b/book/basic-features/jupyterbook.md @@ -86,7 +86,7 @@ et cetera... ``` ## The structure of a chapter -The 'nested' structure in the TOC is one way to organize your book. Another way to do so is in the file itself. The structure is define by the number of `#`: +The 'nested' structure in the TOC is one way to organize your book. Another way to do so is in the file itself. The structure is defined by the number of `#`: ``` # Chapter 1 title @@ -99,3 +99,16 @@ The 'nested' structure in the TOC is one way to organize your book. Another way ### Subsection 1.2.1 ``` + +The depth for numbered subsection can be set in the TOC file: + +``` +parts: +- caption: Part 1 + numbered: 2 + chapters: + - file: chapter_1 + sections: + - file: section_1_1 + - file: section_1_2 +``` \ No newline at end of file