Skip to content

Latest commit

 

History

History
55 lines (51 loc) · 4.17 KB

README.md

File metadata and controls

55 lines (51 loc) · 4.17 KB

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 to make sure that it hasn't been logged already. If not, create a new issue and someone else can pick it up!
  2. Fork the 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/<subject in lower-case><course-number>.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
  1. 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
  1. Create a pull request
  2. 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 to embed LaTeX into our html.
If you are creating a new html file that requires MathJax, include the following script tags into the <head> of your document.

<script type="text/javascript" async
  src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML">
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}
  });
</script>

Tips for MathJax

  • To in-line LaTeX: use $&lt;math&gt;$
  • To centre on page (equation-style): use $$&lt;math&gt;$$

CS-Related Courses

For CS-related courses, we will be using Google's Code-Prettify to format and provide syntax highlighting for our code. To embed it in your code, use either <pre> or <code> with class="prettyprint" and enclose your code segment in it.

Contributors All Contributors


Clayton Halim
💻
Anamaya Garodia
💻
Tate Lok-Chun Cheng
💡
Hassaan Sami
🐛
Domingo
💻