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

update margins

Browse source
This commit is contained in:
Tom van Woudenberg 2025-11-02 08:29:38 +01:00
parent d49d4ecacf
commit d55376cda4
5 changed files with 83 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

21
book/features/draft-release.md
View file

@ -1,14 +1,25 @@
````{margin}
```{admonition} User types
:class: tip
```{note}
{bdg-link-secondary}`Uses TeachBooks package <./teachbooks_intro.html>`
{bdg-link-light}`Included in TeachBooks Template <../external/template/README.html>`
{bdg-link-light}`Supported by Deploy Book workflow <../external/deploy-book-workflow/README.html>`
```{tip}
This page is useful for user type 3-5.
```
{bdg-link-secondary}`Uses TeachBooks package <./teachbooks_intro.html>`
{bdg-link-light}`Included in TeachBooks Template <../external/template/README.html>`
{bdg-link-light}`Supported by Deploy Book workflow <../external/deploy-book-workflow/README.html>`
```{seealso}
[{octicon}`mark-github` Repository](https://github.com/TeachBooks/teachbooks)
[{octicon}`book` Documentation](https://teachbooks.readthedocs.io/latest/cli/cli.html)
```
````

19
book/features/favourites.md
View file

@ -1,6 +1,13 @@
````{margin}
```{admonition} User types
:class: tip
```{note}
{bdg-primary}`Sphinx Extension`
{bdg-link-light}`Included in TeachBooks Template <../external/template/README.html>`
```
```{tip}
This page is useful for user type 3-5.
```
@ -8,6 +15,14 @@ This page is useful for user type 3-5.
{bdg-link-light}`Included in TeachBooks Template <../external/template/README.html>`
```{seealso}
[{octicon}`mark-github` Repository](https://github.com/TeachBooks/TeachBooks-Favourites)
[{octicon}`pencil` Exercise](https://teachbooks.io/template/extension_exercises/017.html)
```
````
# TeachBooks Favourites

29
book/features/release_book_online.md
View file

@ -1,12 +1,31 @@
````{margin}
```{admonition} User types
:class: tip
```{note}
{bdg-link-light}`GitHub Reusable Action: Deploy Book workflow <../external/deploy-book-workflow/README.html>`
{bdg-link-light}`Part of TeachBooks Template <../external/template/README.html>`
{bdg-link-secondary}`Uses TeachBooks package <./teachbooks_intro.html>`
```
```{tip}
This section is useful for user type 3-5.
```
{bdg-link-light}`GitHub Reusable Action: Deploy Book workflow <../external/deploy-book-workflow/README.html>`
{bdg-link-light}`Part of TeachBooks Template <../external/template/README.html>`
{bdg-link-secondary}`Uses TeachBooks package <./teachbooks_intro.html>`
```{seealso}
[{octicon}`mark-github` Repository deploy book workflow](https://github.com/TeachBooks/deploy-book-workflow)
[{octicon}`book` Documentation](../installation-and-setup/versions_URLs.md)
{octicon}`pencil` Exercises:
- [Your version of the book](https://teachbooks.io/template/exercises/004.html)
- [Deploy book workflow](https://teachbooks.io/template/extension_exercises/015.html)
```
````
# Share book online for multiple versions

4
book/features/teachbooks_intro.md
View file

@ -16,9 +16,9 @@ This section is useful for user type 4-5.
```{seealso}
[{octicon}`mark-github` repository](https://github.com/teachbooks/teachbooks)
[{octicon}`mark-github` Repository](https://github.com/teachbooks/teachbooks)
[{octicon}`book` documentation](https://teachbooks.readthedocs.io/)
[{octicon}`book` Documentation](https://teachbooks.readthedocs.io/)
```

28
book/features/write_online.md
View file

@ -1,15 +1,35 @@
````{margin}
```{admonition} User types
:class: tip
```{note}
{bdg-link-light}`Uses Deploy Book workflow <../external/deploy-book-workflow/README.html>`
{bdg-link-light}`Uses TeachBooks Template <../external/template/README.html>`
```
```{tip}
This section is useful for user type 3-5.
```
{bdg-link-light}`Uses Deploy Book workflow <../external/deploy-book-workflow/README.html>`
{bdg-link-light}`Uses TeachBooks Template <../external/template/README.html>`
```{seealso}
[{octicon}`mark-github` Repository deploy book workflow](https://github.com/TeachBooks/deploy-book-workflow)
[{octicon}`mark-github` Repository template](https://github.com/TeachBooks/template)
[{octicon}`book` Documentation](../workflows/collaboration.md)
{octicon}`pencil` Exercises:
- [First file edit](https://teachbooks.io/template/exercises/001.html)
- [Add a new file to the table of contents](https://teachbooks.io/template/exercises/002.html)
- [Change book configuration](https://teachbooks.io/template/exercises/003.html)
- [Syntax exercises](https://teachbooks.io/template/syntax_exercises.html)
```
````
# Write book fully in GitHub interface
Using the GitHub tooling in combination with TeachBook's software, users are able to write their book fully online, without the need to install any software locally. This is especially useful for users that are not familiar with Git and GitHub, or do not have the rights to install software on their computer. To make this possible, users can start with the [TeachBooks Template](../external/template/README.md) after which they make use of the [Deploy Book Workflow](../external/deploy-book-workflow/README.md) to automatically build and release their book online.