mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-13 14:55:51 +00:00
76ab30859c
Split the TeachBooks Python Package and Deploy Book Workflow documentation into dedicated intro pages (teachbooks_intro.md, DBW_intro.md), update references and links throughout feature pages, and revise the _toc.yml structure to include new sections. Added clarifications to favourites and live_code features, improving organization and navigation for users.
30 lines
No EOL
2.1 KiB
Markdown
30 lines
No EOL
2.1 KiB
Markdown
(feature_overview)=
|
|
# Overview
|
|
|
|
As TeachBooks, we collect a suite of existing open-source software so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. As the open-source software landscape changes rapidly, it is essential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching!
|
|
|
|
Since the list of TeachBook features is getting quite long, we have grouped them in categories:
|
|
- Original Jupyter Book and Sphinx features
|
|
- Easy editing process
|
|
- Additional functionality
|
|
- Book styling
|
|
- TeachBooks student-view features
|
|
|
|
Additionally, not all features are built and shared in the same way. We do our best to make sure that as many tools as possible are included automatically when using our TeachBooks Template Book; if you are not using the Template, we try to make sure each of our tools can be used independently. For transparency, tags will help differentiate between the different backgrounds of the features:
|
|
- {bdg-warning}`Javascript overlay`
|
|
- {bdg-success}`Chrome Extension`
|
|
- {bdg-white}`GitHub App and Javascript script`
|
|
- {bdg-link-secondary}`Python Package: teachbooks <./teachbooks_intro.html>`
|
|
- {bdg-link-light}`GitHub Reusable Action: Deploy Book workflow <./DBW_intro.html>`
|
|
- {bdg-light}`GitHub Template`
|
|
- {bdg-dark}`Git Workflow`
|
|
- {bdg-primary}`Sphinx Extension`
|
|
- {bdg-primary-line}`Part of TeachBooks Favourites`
|
|
- {bdg-danger}`iframe`
|
|
- {bdg-success}`WebApp`
|
|
|
|
Finally, the purpose, installation process and usage of each features is elaborated on in the respective sub-sections.
|
|
|
|
To see examples for these features, go to the [Examples chapter](../examples/overview.md).
|
|
|
|
As the [TeachBooks Python Package](./teachbooks_intro.md), the [Deploy Book Workflow](./DBW_intro.md) and [TeachBooks Favourites](./favourites.md) are important tools that incorporate and deploy more than one feature, an additional explanation is provided here in subpages in more detail, with links to the pages in this manual where individual features are described. |