Skip to content

Commit 849dda8

Browse files
authored
Merge branch 'main' into branchsam
2 parents 0ceddf0 + 90d55a0 commit 849dda8

12 files changed

Lines changed: 56 additions & 41 deletions

README.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,28 @@ This repository is designed to help you quickly get started with [PreTeXt](https
55
---
66

77
## 🚀 Quick Start Guide
8+
9+
## 🚀 How to Create Your Own PreTeXt-Codespace Repository
10+
11+
There are two easy ways to set up your own PreTeXt-enabled Codespace:
12+
13+
### ✅ Option 1: Fork This Repository
14+
15+
1. Visit [fragandi/CURITutorialDevelopment2025](https://github.com/fragandi/CURITutorialDevelopment2025).
16+
17+
2. Click **"Fork"** (top-right) to copy it to your GitHub account.
18+
3. Open your new forked repository and click **"Code" → "Create codespace on main"**.
19+
20+
### 🛠️ Option 2: Set Up a Fresh Repository Manually
21+
22+
1. Create a new GitHub repository in your account.
23+
2. Copy the entirity of `.devcontainer/`, `.github/`, `.gitignore`, `requirements.txt` folder from [fragandi/CURITutorialDevelopment2025](https://github.com/fragandi/CURITutorialDevelopment2025).
24+
3. (Recommended) Also copy the following for a smoother experience:
25+
- The `README_images/` folder and `README.md` file (for guidance and troubleshooting)
26+
4. Push your changes and create a Codespace from the repository.
27+
28+
This option gives you more flexibility to customize your setup while keeping the essential PreTeXt environment.
29+
830
Once the Codespace has finished creating, **check that PreTeXt is installed** by running:
931

1032
```bash
@@ -45,17 +67,27 @@ If you see an error like **command not found**, follow these steps:
4567

4668
## 🌐 GitHub Pages Configuration
4769

48-
Make sure to configure GitHub Pages to use **GitHub Actions** as the build and deployment source.
70+
Make sure to configure GitHub Pages to use **GitHub Actions** as the build and deployment source:
71+
72+
1. Go to your repository’s **Settings****Pages**.
73+
2. Under **Build and deployment**, set the source to **GitHub Actions**.
74+
75+
<img src="README_images/image-pages_source.png" alt="GitHub Pages Source" style="border: 2px solid green;">
76+
77+
---
78+
79+
## 🛠 GitHub Environment Configuration
4980

50-
1. Go to your repository's **Settings** → **Pages**.
51-
2. Under **Build and deployment**, set the source to **GitHub Actions** as shown below:
81+
Go to your repository **Settings****Environments** → click on `github-pages`, and make sure it looks similar to the following:
5282

53-
![GitHub Pages Source](README_images/image-pages_source.png)
83+
<img src="README_images/image-environment-pages.png" alt="GitHub Pages Environment Setup" style="border: 2px solid green;">
84+
<br>
85+
<img src="README_images/image-environment.png" alt="Environment Overview" style="border: 2px solid green;">
5486

5587
---
5688

5789
## ⏱ Deployment Time
5890

59-
Deployment takes about **4 minutes**. After triggering the deployment, wait a few minutes, then check your site via the GitHub Pages link.
91+
Deployment usually takes about **4 minutes**. After triggering the deployment, wait a few minutes and then visit your GitHub Pages URL.
6092

61-
![GitHub Actions Deployment](README_images/image-actions-deployment.png)
93+
<img src="README_images/image-actions-deployment.png" alt="GitHub Actions Deployment" style="border: 2px solid green;">
68.7 KB
Loading
50.5 KB
Loading
115 KB
Loading
128 KB
Loading
81.3 KB
Loading
22.2 KB
Loading
125 KB
Loading

assets/screenshots/fork_repo.png

69.9 KB
Loading

source/ch-M2.ptx

Lines changed: 4 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,9 @@
55
<p>
66
This chapter is co-authored by Francesca Gandini, Sumner Strom, Al Ashir Intisar
77
</p>
8-
</introduction>
9-
<!-- <section xml:id="sec-template">
10-
<title>Template </title>
11-
<p>
12-
This is the introduction to the template.
13-
</p>
14-
<subsection xml:id="subsec-template">
15-
<title>Template Subsection</title>
16-
<p>
17-
This is the template subsection.
18-
</p>
19-
20-
</subsection>
21-
</section> -->
22-
23-
<!-- <section xml:id="sec-notes">
24-
<title>Notes</title>
25-
26-
<subsection xml:id="subsec-notes">
27-
<title>Notes Subsection</title>
28-
<p>
29-
To build in pretext use the template subsection and pretext environment features.
30-
Make sure that you are building and compiling from main using preview code chat.
31-
Additionally, when running if the compilation fails run the command "pretext build web" in terminal.
32-
Make sure that all of the xml have unique ids so that you dont run into compilation errors.
33-
Follow the other chapters to find out how things are used.
34-
Make sure that the sections are properly linked within the main.ptx. Additionally, use the subsections and sections for organization.
35-
If something doesnt display there is a paragraph line missing.
36-
37-
</p>
38-
39-
</subsection>
40-
</section>-->
8+
9+
10+
4111
<section xml:id="sec-m2-codespace">
4212
<title>Creating a M2 Codespace</title>
4313

@@ -514,4 +484,5 @@ This chapter is co-authored by Francesca Gandini, Sumner Strom, Al Ashir Intisar
514484
</section>
515485

516486
</section>
487+
517488
</chapter>

0 commit comments

Comments
 (0)