admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-13 14:55:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update book/features/external_toc.md

Browse source 
Co-authored-by: Bart Schilperoort <b.schilperoort@gmail.com>
This commit is contained in:
Tom van Woudenberg 2025-03-05 07:13:34 +01:00 • committed by GitHub
parent b82e6b9c19
commit 36aafe5c59
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
book/features/external_toc.md
View file

@ -20,7 +20,7 @@ These features are not incorporated in the new workflow yet.
## What does it do?
This functionality, part of the [TeachBooks package](https://github.com/TeachBooks/TeachBooks) allows you to refer to `.ipynb` and `.md` files stored on public repositories. These files are then handles as if they were normal files in your book, leading to a the file as a page in your built book. To prevent issues it warns you if there's a mismatch in `requirements.txt`, combines `.bib`-files, merges plugins in `_config.yml` and checks licenses.
This functionality, part of the [TeachBooks package](https://github.com/TeachBooks/TeachBooks) allows you to refer to `.ipynb`, `.md` and `.rst` files stored on public repositories. These files are then handles as if they were normal files in your book, leading to a the file as a page in your built book. To prevent issues it validates that the external content has a permissive license, automatically combines any `reference.bib` files, and warns you if there's a mismatch in `requirements.txt` or with plugins in `_config.yml`.
## Installation
To use this extenstion, follow these steps: