|
3 | 3 |
|
4 | 4 | This repository stores the source of Computorg. |
5 | 5 |
|
6 | | - |
7 | 6 | ## How to contribute to the website |
8 | 7 |
|
9 | | -- Install [quarto](https://quarto.org/docs/get-started/) |
| 8 | +### Quarto |
| 9 | + |
| 10 | +Our website has been built with [Quarto](https://quarto.org), an open-source scientific and technical publishing system. The first thing you need to compile the website is therefore to install Quarto, which can be done by downloading the corresponing installer here: <https://quarto.org/docs/get-started/>. |
| 11 | + |
| 12 | +::: {.callout-note} |
| 13 | +## Positron |
| 14 | + |
| 15 | +If you are using the new [Positron IDE](https://positron.posit.co), quarto is already bundled with it. You can simply type `which quarto` within the built-in terminal in Positron and add the returned path to your `PATH`. |
| 16 | +::: |
| 17 | + |
| 18 | +### Microsoft DotNet SDK |
10 | 19 |
|
11 | | -- Install DotNet SDK 8.0 |
| 20 | +You need to install Microsoft DotNet SDK which is now v9.0. Installers can be found here: <https://dotnet.microsoft.com/en-us/download>. Otherwise, you can install it on Unix systems via: |
12 | 21 |
|
13 | | - - Linux: |
14 | | - ```bash |
15 | | - sudo apt-get install dotnet-sdk-8.0 |
16 | | - ``` |
17 | | - - macOS: |
18 | | - ```bash |
19 | | - brew install dotnet |
20 | | - ``` |
| 22 | +- Linux: |
| 23 | +```bash |
| 24 | +sudo apt-get install dotnet-sdk-9.0 |
| 25 | +``` |
| 26 | +- macOS: |
| 27 | +```bash |
| 28 | +brew install dotnet |
| 29 | +``` |
21 | 30 |
|
22 | | -- Create an API key on github (personal access token) |
| 31 | +### GitHub Personal Access Token |
23 | 32 |
|
24 | | - - Go to your settings |
25 | | - - Then developer settings |
26 | | - - Then create a github token |
| 33 | +You need to connect to your GitHub account. |
27 | 34 |
|
| 35 | +- Go under *Settings*, scroll down until you see the *Developer settings* tab on the left sidebar and click on it. Follow the procedure to create a **classic** personal access token (PAT). Give it a name you will remember and remember to copy the PAT before closing the page. |
28 | 36 | - Put the token in a file named `.env-secret` in the root of this repository |
29 | 37 |
|
30 | | - ```bash |
31 | | - GITHUB_TOKEN=your_github_token |
32 | | - ``` |
| 38 | +```bash |
| 39 | +GITHUB_TOKEN=your_github_token |
| 40 | +``` |
33 | 41 |
|
34 | | -- Now, you can compile the website with `quarto render .` |
| 42 | +Now, you can compile the website with `quarto render .`. |
0 commit comments