https://github.com/theroughcode/course-notes
:books: Open-Source Course Notes for UW Students
https://github.com/theroughcode/course-notes
code-prettify html latex mathjax notes university
Last synced: about 1 year ago
JSON representation
:books: Open-Source Course Notes for UW Students
- Host: GitHub
- URL: https://github.com/theroughcode/course-notes
- Owner: theRoughCode
- Created: 2017-04-02T20:50:28.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-01-08T00:30:04.000Z (over 8 years ago)
- Last Synced: 2025-05-07T02:04:43.065Z (about 1 year ago)
- Topics: code-prettify, html, latex, mathjax, notes, university
- Language: HTML
- Homepage: http://raphaelkoh.me/Course-Notes/
- Size: 1.68 MB
- Stars: 6
- Watchers: 2
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Course-Notes
Hey everyone! This repo was created initially for me to study/increase the lifespan and legacy of my notes. However, I realized that I could go further and make this open-source. So, here it is!
## How Do I Contribute?
If you find a typo or an error or if you have suggestions on something to add, you can:
1. Check the [issue tracker](https://github.com/theRoughCode/Course-Notes/issues) to make sure that it hasn't been logged already. If not, create a [new issue](https://github.com/theRoughCode/Course-Notes/issues/new) and someone else can pick it up!
2. [Fork the repo](https://help.github.com/articles/fork-a-repo/) following the instructions below and submit a pull request with the change!
### Forking The Repo
If you found an issue you can fix or implement, you should contribute directly to the code base!
1. Fork this repo.
2. Create a branch with a descriptive name. For example, if you're fixing issue #5:
```git checkout -b 5-fix-styling-for-math-146```
3. If you're creating a new course, create a new file "courses/\\.html"
4. Implement your feature. Don't be afraid to ask questions!
5. Once you've finished implementing your changes, make sure that your master branch is up-to-date with the remote master branch
```
git remote add upstream git@github.com:theroughcode/Course-Notes.git
git checkout master
git pull upstream master
```
6. Update your feature branch with your master branch.
```
git checkout 5-fix-styling-for-math-146
git rebase master
git push --set-upstream origin 5-fix-styling-for-math-146
```
7. Create a [pull request](https://github.com/theRoughCode/Course-Notes/pulls)
8. Your PR will be merged once a project maintainer approves it and merges it!
## What Should I Take Note Of?
### Math-Related Courses
For math-related courses, we will be making use of [MathJax](https://www.mathjax.org/) to embed LaTeX into our html.
If you are creating a new html file that requires MathJax, include the following script tags into the \ of your document.
```html
MathJax.Hub.Config({
tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}
});
```
#### Tips for MathJax
- To in-line LaTeX: use $\$
- To centre on page (equation-style): use $$\$$
### CS-Related Courses
For CS-related courses, we will be using Google's [Code-Prettify](https://github.com/google/code-prettify) to format and provide syntax highlighting for our code. To embed it in your code, use either ```
``` or `````` with ```class="prettyprint"``` and enclose your code segment in it.
## Contributors [](#contributors)
| [
Clayton Halim](https://github.com/clayton-halim)
[💻](https://github.com/theRoughCode/Course-Notes/commits?author=clayton-halim "Code") | [
Anamaya Garodia](https://github.com/anamayagarodia)
[💻](https://github.com/theRoughCode/Course-Notes/commits?author=anamayagarodia "Code") | [
Tate Lok-Chun Cheng](https://github.com/tate1010)
[💡](#example-tate1010 "Examples") | [
Hassaan Sami](https://github.com/hsami10)
[🐛](https://github.com/theRoughCode/Course-Notes/issues?q=author%3Ahsami10 "Bug reports") | [
Domingo](https://github.com/domingohui)
[💻](https://github.com/theRoughCode/Course-Notes/commits?author=domingohui "Code") |
| :---: | :---: | :---: | :---: | :---: |