|
1 | 1 |
|
2 | 2 |
|
3 |
| -# Quarto course website template |
| 3 | +This repo contain code for the Transport Data Science module at the |
| 4 | +Institute for Transport Studies, University of Leeds. |
4 | 5 |
|
5 |
| -A template for course websites developed with |
6 |
| -[Quarto](https://quarto.org) and hosted on GitHub. |
| 6 | +To set it up we used commands such as: |
7 | 7 |
|
8 |
| -This is all configured so you only need to edit the source files in |
9 |
| -Quarto (.qmd). The website is generated and hosted automatically by |
10 |
| -GitHub. |
11 |
| - |
12 |
| -Example website: |
13 |
| -https://pakillo.github.io/quarto-course-website-template (see also |
14 |
| -https://github.com/rstudio-conf-2022/teach-ds-course-website for a more |
15 |
| -developed example). |
16 |
| - |
17 |
| -## Using this template |
18 |
| - |
19 |
| -1. Click on green button “Use this template” -\> “Create a new |
20 |
| - repository” |
21 |
| - |
22 |
| -2. Choose a name for your repository |
23 |
| - |
24 |
| -3. Important: check ‘Include all branches’ when creating the repository |
25 |
| - (because we will need the `gh-pages` branch to host the website). |
26 |
| - |
27 |
| -4. Once your repo is created, remember to update the links to your |
28 |
| - GitHub repo in [\_quarto.yml](_quarto.yml), replacing ‘Pakillo’ with |
29 |
| - your GitHub username. |
30 |
| - |
31 |
| -To create an empty branch and take a look at the [Quarto |
32 |
| -documentation](https://quarto.org/docs/publishing/github-pages.html): |
33 |
| - |
34 |
| -``` bash |
35 |
| -git checkout --orphan gh-pages |
36 |
| -git reset --hard # make sure all changes are committed before running this! |
37 |
| -git commit --allow-empty -m "Initialising gh-pages branch" |
38 |
| -git push origin gh-pages |
| 8 | +``` r |
| 9 | +usethis::use_description() |
| 10 | +usethis::use_package("stats19") |
| 11 | +usethis::use_package("DT") |
| 12 | +usethis::use_package("quarto") |
39 | 13 | ```
|
0 commit comments