Skip to content

Commit 699afcb

Browse files
authored
Update README.md
1 parent 1b80aa0 commit 699afcb

1 file changed

Lines changed: 5 additions & 47 deletions

File tree

README.md

Lines changed: 5 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,14 @@
1-
s# Markdown Slide Master
1+
# python-summer
22

3-
This repository contains a template for creating slides and books using Quarto. It is designed to be used as a starting point for your own courses in HES-SO Valais-Wallis style.
3+
introduction to code with Python.
44

5-
The repository includes Continous Integration (CI) configuration for automatic deployment of the book and slides to GitHub Pages.
6-
The individual GitHub Pages should then be linked on moodle.
5+
Programming with Python 5 courses.
76

8-
The output generated by this template is available at [https://duerrsimon.github.io/hevs-quarto/](https://duerrsimon.github.io/hevs-quarto/).
7+
From basics to pandas.
98

9+
Focused on data analysis.
1010

11-
## How to use this template
12-
1. Create a new repository from this template on GitHub
13-
2. Either locally or on Github, edit the `quarto.yml` file to set the title, author, and other metadata for your course.
14-
3. Edit the `index.qmd` file to provide an overview of your course.
15-
4. Edit the `_quarto-book.yml` file to set the book title, author, and other metadata. Also add your course structure in the `chapters` section.
16-
5. Modify the `base_url` in `_variables.yml`. it should be `githubusername.github.io/reponame/`
17-
6. Add your course content in the `Week1`, `Week2`, etc. directories, following the structure of the provided example.
1811

19-
The quarto documentation is available at [https://quarto.org/docs/](https://quarto.org/docs/).
2012

21-
Note that you can exempt certain parts of the document to show up in the public material by using
2213

23-
```
24-
::: {.onlyteacher}
25-
Your content here
26-
:::
27-
```
28-
29-
30-
## How to locally preview and render the book and slides
31-
For course development, you can preview and render the book and slides locally using Quarto. For production use and deployment, it is recommended to use the CI/CD pipeline provided in this repository.
32-
33-
#### Install Quarto
34-
Follow the instructions at [https://quarto.org/docs/get-started/](https://quarto.org/docs/get-started/) to install Quarto on your system.
35-
36-
#### Live preview of a single slide set
37-
```
38-
quarto preview Week1/slides.md
39-
```
40-
41-
#### Live preview of the book
42-
```
43-
quarto preview --profile book
44-
```
45-
46-
#### Generate book and slides locally
47-
```
48-
quarto render --profile book
49-
```
50-
The files will be generated in the `_book` directory. You can then open the `index.html` file in your browser to view the book.
51-
The slides will be generated in the `_slides` folder.
52-
53-
Additionally a PDF of the book will be generated.
54-
55-
GitHub Actions will automatically also generate a PDF version of the slides.
5614

0 commit comments

Comments
 (0)