Skip to content

Commit

Permalink
Merge pull request #7 from ITSLeeds/6-update-schedule
Browse files Browse the repository at this point in the history
Add schedule, close #6
  • Loading branch information
Robinlovelace authored Jul 23, 2024
2 parents 43cd457 + 303d1fb commit 45ea880
Show file tree
Hide file tree
Showing 3 changed files with 453 additions and 150 deletions.
37 changes: 15 additions & 22 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,24 @@
format: gfm
---

# Quarto course website template

A template for course websites developed with [Quarto](https://quarto.org) and hosted on GitHub.

This is all configured so you only need to edit the source files in Quarto (.qmd). The website is generated and hosted automatically by GitHub.

Example website: https://pakillo.github.io/quarto-course-website-template (see also https://github.com/rstudio-conf-2022/teach-ds-course-website for a more developed example).


## Using this template

1. Click on green button "Use this template" -> "Create a new repository"
```{r}
#| eval: false
# init and snapshot renv:
renv::init()
renv::snapshot()
```

2. Choose a name for your repository
```{r}
#| eval: false
# Update packages after development work as follows:
renv::snapshot() # then select "2" to update the lockfile
```

3. Important: check 'Include all branches' when creating the repository (because we will need the `gh-pages` branch to host the website).
<!-- # Quarto course website template
4. Once your repo is created, remember to update the links to your GitHub repo in [_quarto.yml](_quarto.yml), replacing 'Pakillo' with your GitHub username.
A template for course websites developed with [Quarto](https://quarto.org) and hosted on GitHub.
To create an empty branch and take a look at the [Quarto documentation](https://quarto.org/docs/publishing/github-pages.html):
This is all configured so you only need to edit the source files in Quarto (.qmd). The website is generated and hosted automatically by GitHub.
```bash
git checkout --orphan gh-pages
git reset --hard # make sure all changes are committed before running this!
git commit --allow-empty -m "Initialising gh-pages branch"
git push origin gh-pages
```
Example website: https://pakillo.github.io/quarto-course-website-template (see also https://github.com/rstudio-conf-2022/teach-ds-course-website for a more developed example). -->

Loading

0 comments on commit 45ea880

Please sign in to comment.