---
# System prepended metadata

title: Course Website

---

# CAS Lab Course Website

## Create a New Website

### Fork from the one in the previous year

* Press fork
![image](https://hackmd.io/_uploads/rkKyW7t4ex.png)
* Name the website with the form - "[CourseName][CourseYear]-Web", eg. AAML2025-Web
* Make sure the repository is in the nycu-caslab organization
* Also remember to make the repository public to ensure it is accessible 
![image](https://hackmd.io/_uploads/SJdG-mK4gg.png)
* Enable actions in the setting
![image](https://hackmd.io/_uploads/r1FqzQK4ll.png)
* Update the `conf.py`
![image](https://hackmd.io/_uploads/B1qzmXY4le.png)
* In settings -> Pages -> Build and deployment -> Branch, choose the gh-pages branch to deploy
![image](https://hackmd.io/_uploads/HyDHmQFVex.png)


## Modify the Website

### Environment

* Create the python virtual environment

```
python3 -m venv venv
source venv/bin/activate
```

* Install the required packages

```python
pip install Sphinx
pip install myst-parser
pip install sphinx-book-theme
```
or
```python
pip install -r requirements.txt
```

### Usage

* Modify the `.md` or `.rst` files
* Build the website using `make`
```
make html
```
* Clean the `_build` using `make clean`
* If you want to preview the website locally, you can use a tool like the **Live Server** extension in VS Code.