mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-12 22:35:51 +00:00
Update book.md
This commit is contained in:
parent
5673b85447
commit
bd4dcd383e
1 changed files with 4 additions and 11 deletions
|
|
@ -18,9 +18,9 @@ Never seen a TeachBook before? Here's a small demo of our MUDE-book!
|
|||
So what are you looking at? It's a website generated with the [Jupyter Book package](https://jupyterbook.org/). Various extensions have been added to improve the student-experience, especially for technical topics!
|
||||
|
||||
The source files of this book consists of three parts:
|
||||
1. A configuration file, `_config.yml`
|
||||
2. A table of contents file, `_toc.yml`
|
||||
3. Content for your book! Text-based files.
|
||||
1. A configuration file to define functionalities, `_config.yml`
|
||||
2. A table of contents file to list which files should endup in the book, `_toc.yml`
|
||||
3. Content for your book! Text-based files which allows you to embed figures, videos, math and interactive elements.
|
||||
|
||||
```{admonition} Text-based files? yml? What is that?!
|
||||
:class: tip, dropdown
|
||||
|
|
@ -34,12 +34,6 @@ YAML (or YML) is a text-based file format that is primarily used to store data.
|
|||
|
||||
A book is made by by writing content in text-based files such as Markdown (`*.md`), Jupyter Notebooks (`*.ipynb`), etc. After that, software is used to "parse" these files and create the final book (e.g., Jupyter Book)
|
||||
|
||||
|
||||
A hint of the key tools
|
||||
- Python
|
||||
- Git and GitHub
|
||||
- A web browser
|
||||
|
||||
```{admonition} Comparing and Contrasting to LaTeX
|
||||
|
||||
Have you ever used LaTeX? It turns out there are a lot of similarities with this document system. Here is a quick list:
|
||||
|
|
@ -49,5 +43,4 @@ Have you ever used LaTeX? It turns out there are a lot of similarities with this
|
|||
4. Sometimes you can spend more time than you like troubleshooting "bugs" that turn out to be simple syntax errors.
|
||||
```
|
||||
|
||||
|
||||
the rest is just
|
||||
Let's see how these books are made!
|
||||
Loading…
Add table
Add a link
Reference in a new issue