Contributing¶

If you create new files, please update nav.yml accordingly.

Notes¶

Prepare a link to the notes.
Find the markdown file for the corresponding subject in docs/notes/. E.g., comp.md is for Computer Science courses. You may create a new markdown file if there has not been one for the subject.

In the file, please follow this format:

# <subject abbreviation> - <subject full name>

## <course code>

Course Name: <course full name>

### Notes

| link | offering | format | author | remark |
| :-: | :- | :- | :- | :- |
| <link> | <offering> | <format> | <author> | <remark> |

### Review / Comment / Suggestions

Advise, exchange experience, research and others¶

For other advice, add/edit files in docs/:

Exchange experience: add/edit docs/ex/<school-abbr>.md
Research: add/edit docs/res/<title>.md

To preview locally¶

Clone this repo.

git clone git@github.com:HKUST-Courses/HKUST-Courses.github.io.git
cd HKUST-Courses.github.io

Install required Python packages.
```
pip install -r requirements-dev.txt
```
Run mkdocs server
```
mkdocs serve
```
Preview the website at localhost:8000