Skip to content

Commit 524220b

Browse files
committed
feat(setup): write page
1 parent 9b67fe4 commit 524220b

File tree

5 files changed

+39
-7
lines changed

5 files changed

+39
-7
lines changed

pages/setup.qmd

Lines changed: 39 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,47 @@
11
---
2-
title: 1. Set-up
2+
title: "(1) Set-up"
33
---
44

5-
Plan for page:
5+
::: {.pale-blue}
66

7-
create a github account
7+
**On this page we will:**
88

9-
what is github?
9+
* Create a GitHub account.
10+
* Open the Quarto website template in a web browser.
11+
* Start a GitHub Codespace from the template.
1012

11-
now, lets open codespace
13+
:::
1214

13-
what is codespace?
15+
## Create a GitHub account
1416

15-
what is rstudio?
17+
**GitHub** is a website where you can save files, track changes over time, and work together with other people on the same material. It is very popular for code, but you can also use it for documents, data, and teaching materials.
18+
19+
When your work is on GitHub, it is backed up in the cloud and you can access it from any computer with a web browser.
20+
21+
Sign up for an account here: <https://github.com/signup>
22+
23+
[![](setup/github_account.png){fig-alt="Screenshot from GitHub page to create a new account."}](https://github.com/signup)
24+
25+
## Go to our template repository
26+
27+
A **repository** (or **repo**) is just a folder on GitHub that holds all the files for one project, plus the full history of changes.
28+
29+
Our template repository is a ready-made project you can copy, so you start with all the right files and settings instead of building everything from scratch.
30+
31+
Go to our template repository here: <https://github.com/pythonhealthdatascience/quarto-template>
32+
33+
[![It may look a little different from this screenshot if we have changed the repository since writing this page!](setup/quarto-template.png){fig-alt="Screenshot of quarto-template GitHub repository"}](https://github.com/pythonhealthdatascience/quarto-template)
34+
35+
## Open GitHub codespaces.
36+
37+
**GitHub Codespaces** gives you a ready-to-use workspace in your browser, so you do not need to install any software on your own computer. We will use it only to open and edit the text files that make up your Quarto website - you will not need to write any code.
38+
39+
To open a codespace from the template repository, click the green **Code** button, then choose the **Codespaces** tab, and click **Create codespace on main**.
40+
41+
![](setup/create_codespace.png){fig-align="center" fig-alt="Screenshot of repository showing Code > Codespaces > Create codespace on main"}
42+
43+
> You may see a message that Codespace usage for this repository is paid for by your account. For personal GitHub Free accounts, you get 120 hours of Codespaces time and 15 GB of storage each month at no cost. If you ever reach that free limit and have not added any card or payment method, GitHub will simply stop your Codespaces until the next month; you will not be charged.
44+
45+
GitHub will take a minute to prepare your Codespace, then open an editor in the browser with your project files on the left and a main editing area in the centre.
46+
47+
![](setup/open_codespace.png){fig-alt="Screenshot of the generated GitHub codespace."}

pages/setup/create_codespace.png

35.4 KB
Loading

pages/setup/github_account.png

272 KB
Loading

pages/setup/open_codespace.png

65.3 KB
Loading

pages/setup/quarto-template.png

143 KB
Loading

0 commit comments

Comments
 (0)