mirror of
https://github.com/TeachBooks/template.git
synced 2026-11-12 22:25:52 +00:00
20 lines
No EOL
1.1 KiB
Markdown
20 lines
No EOL
1.1 KiB
Markdown
(intro)=
|
|
# Welcome to the Template Book
|
|
|
|
_This is the first page the student will see when opening the url._
|
|
|
|
This book can be used as a template for other books. It includes a starter package of the software developed by the TeachBooks initiative and some exercises to get you going!
|
|
|
|
```{admonition} Exercise 1: Edit contents
|
|
:class: tip
|
|
|
|
Can you add some content to this page? Let's start with just some text!
|
|
|
|
1. Go to the source file of this page on your GitHub repository (`https://github.com/<your_username>/<your_repo_name>`) - {octicon}`code;1em` `Code` - `Book` - `intro.md` - {octicon}`pencil;1em` `Edit this file`
|
|
2. Add some text
|
|
3. Click `Commit changes`
|
|
4. Add a description of your change
|
|
5. Select `Commit directly to the main branch` (this adds your change your change to the default version instead of making a new one)
|
|
6. Click `Commit changes`
|
|
7. Go to {octicon}`play;1em` `Actions` - The most recent workflow run `Update intro.md / the name of the commit you just made` - Wait for it to finish - In the summary, click on the link of your book shown in the table `Branches deployed` and under `Primary book at root`
|
|
``` |