Skip to content
Snippets Groups Projects
Unverified Commit f3f8cfc8 authored by mmcky's avatar mmcky Committed by GitHub
Browse files

DOCS: update start/overview section on _toc.yml (#1517)


* update section on _toc.yml

* Update docs/start/overview.md

Co-authored-by: default avatarChris Holdgraf <choldgraf@berkeley.edu>

* Update docs/start/overview.md

Co-authored-by: default avatarChris Holdgraf <choldgraf@berkeley.edu>

Co-authored-by: default avatarChris Holdgraf <choldgraf@berkeley.edu>
parent 5329ca2a
No related branches found
No related tags found
No related merge requests found
...@@ -140,22 +140,18 @@ file in each folder in order for any sub-folders to be parsed. ...@@ -140,22 +140,18 @@ file in each folder in order for any sub-folders to be parsed.
```yaml ```yaml
# In _toc.yml # In _toc.yml
- file: landing-page format: jb-book
root: landing-page
chapters:
- file: page1 - file: page1
``` ```
Each item in the `_toc.yml` file points to a single file. The links The `_toc.yml` is arranged with a `format` such as `jb-article`, or `jb-book`.
should be **relative to your book's folder and with no extension.** The `root` item is considered the landing page (for `html` builds) and is used as front matter (for `latex` builds).
Think of the top-most level of your TOC file as **book chapters** (excluding the landing page). The title of each chapter will be inferred from the title in your files. For `jb-book`, subsequent chapters can be added under the `chapters:` section in the `yml` file.
The first file specifies the **landing page** of your book (in this case, it is a **markdown file**). Each entry relates to a file, and they should be added as names with **no extensions** and **relative to your book's root folder.**
The landing page is the highest page in your book's content hierarchy. The title of each chapter will be inferred from the title in your files.
The second file specifies a **content page** of your book (in this case, it is a **Jupyter Notebook**).
```{margin}
For more information about how section structure maps onto book structure,
see [](toc/structure).
```
:::{admonition} More about `_toc.yml` :::{admonition} More about `_toc.yml`
:class: tip :class: tip
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment