From c8720288681a9c9067d8dea11401d92971f4bf55 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Tue, 5 Nov 2024 20:31:34 +0100 Subject: [PATCH] set2 --- book/basic-features/jupyterbook.md | 6 +++--- book/examples/book_structure.md | 2 +- book/examples/overview.md | 2 +- book/features/overview.md | 2 +- book/installation-and-setup/git-setup_local.md | 4 ++-- book/installation-and-setup/jupyter-book-setup.md | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/book/basic-features/jupyterbook.md b/book/basic-features/jupyterbook.md index cb04343..6737a17 100644 --- a/book/basic-features/jupyterbook.md +++ b/book/basic-features/jupyterbook.md @@ -9,7 +9,7 @@ To build a Jupyter Book, you need three things: ## The configuration file The configuration file of Jupyter Books is named `_config.yml`. It mainly contains settings that apply when building the book. Here is a basic example of a configuration file, taken from this book: -```yml +```yaml title: Jupyter Book Manual author: Interactive Textbooks CiTG logo: images/TUDelft_logo_rgb.png @@ -43,7 +43,7 @@ The configuration and table of contents files are in YAML format (short for YAML The table of contents (`_toc.yml`) file is where you define the structure of your book. You can organize content in *parts*, *chapters*, and *sections* (and subsections, each new section creating a dropdown menu in the ToC). This is what a table of contents could look like: -```yml +```yaml - format: jb-book - root: intro @@ -61,7 +61,7 @@ et cetera... `root` is the landing page of your book. It will be the first page that people see when they visit the book. You can include files by providing their *relative* path (so the location with respect to `_toc.yml`). These files can be a combination of Markdown, Jupyter Notebooks, and Restructured Text. The example above does not have parts, so the menu on the left will consist of just a list of the chapters. You can also group chapters in parts like this: -```yml +```yaml - format: jb-book - root: diff --git a/book/examples/book_structure.md b/book/examples/book_structure.md index daba15f..db702ee 100644 --- a/book/examples/book_structure.md +++ b/book/examples/book_structure.md @@ -16,7 +16,7 @@ DSAIE Overview Page ``` While the left menu shows the first two chapters in the table of contents (Home & Logistics), the right hand side menu shows the sections of the current chapter where an introduction is given on the different units of the course, the responsible lecturers as well as the schedule of lectures and practicals. Additionally, the book layout is explained to the students which can help clarify how to use the interactive sections! -The anatomy of a jupyter book is explained more in detail in [this](/jupyter-book-manual/book/basic-features/jupyterbook.md) page. In short, you can create structure in your book by having chapters and subschapters defined in the `.toc` file. In each chapter you can organize the content in sections using the `#` syntax which is visible in the menu on the right. +The anatomy of a jupyter book is explained more in detail on [this page](../basic-features/jupyterbook.md). In short, you can create structure in your book by having chapters and subschapters defined in the `.toc` file. In each chapter you can organize the content in sections using the `#` syntax which is visible in the menu on the right. ## Tagged content diff --git a/book/examples/overview.md b/book/examples/overview.md index 160131d..595f6a1 100644 --- a/book/examples/overview.md +++ b/book/examples/overview.md @@ -1,4 +1,4 @@ -# Overview +# TeachBooks Examples This chapter will showcase some TeachBooks making great use of Jupyter Book and TeachBooks features. They can serve as an inspiring starting point for structuring your own TeachBook or just to get an idea of how other teachers and students are using it. Lastly some example pages are shown which combine theory and interactive questions and coding to different degrees. diff --git a/book/features/overview.md b/book/features/overview.md index ea508a4..989d876 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -8,5 +8,5 @@ This chapter provides a list of commonly used book features together with sub-pa - how to use them - where to find the source code -To see examples for these features, go to the [Examples chapter](/book/examples/overview.md). +To see examples for these features, go to the [Examples chapter](../examples/overview.md). diff --git a/book/installation-and-setup/git-setup_local.md b/book/installation-and-setup/git-setup_local.md index 3444fd1..b765577 100644 --- a/book/installation-and-setup/git-setup_local.md +++ b/book/installation-and-setup/git-setup_local.md @@ -127,6 +127,6 @@ This is a (non-exhaustive) list of terminology that will be used in Git for loca - Tracked (files): files that Git knows about and keeps track of their history. - Untracked (files): files that Git does not yet know about. -## More on GitLab +## More on GitLab/GitHub -To get to know more about working in GitLab and getting familiar with its features, click [here](/jupyter-book-manual/book/workflows/overview.md) or watch this [video](https://www.youtube.com/watch?v=1SBtM3znviU&t=1s)! \ No newline at end of file +To get to know more about working in GitLab/GitHub and getting familiar with its features, click [here](../workflows/collaboration.md) or watch this [video](https://www.youtube.com/watch?v=1SBtM3znviU&t=1s)! \ No newline at end of file diff --git a/book/installation-and-setup/jupyter-book-setup.md b/book/installation-and-setup/jupyter-book-setup.md index a916543..a947a77 100644 --- a/book/installation-and-setup/jupyter-book-setup.md +++ b/book/installation-and-setup/jupyter-book-setup.md @@ -5,7 +5,7 @@ This page is useful for user type 5. ``` -Jupyter book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. At TeachBooks we developed a Python package called `teachbooks` which takes over the these features and adds [additional features](/book/features/overview.md). One of those additional features, for example, is the workflow to GitHub Pages. +Jupyter book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository. At TeachBooks we developed a Python package called `teachbooks` which takes over the these features and adds [additional features](../features/overview.md). One of those additional features, for example, is the workflow to GitHub Pages. Concretely, this means that the teachbooks package can be used to replace the Jupyter book package when calling these features. You could think of it as `jupyter-book` being a dependency of `teachbooks`.