2019-09-18 15:33:28 +05:30
|
|
|
# Lecture_Notes
|
|
|
|
|
This repository is there to store the combined lecture notes of all the lectures. We are using markdown to write the lecture notes.
|
2019-10-10 16:28:23 +05:30
|
|
|
|
|
|
|
|
|
|
|
|
|
To render math in the notes, use https://chrome.google.com/webstore/detail/mathjax-plugin-for-github/ioemnmodlmafdkllaclgeombjnmnbima
|
2019-10-10 16:55:37 +05:30
|
|
|
|
|
|
|
|
|
|
|
|
|
Guidelines:
|
|
|
|
|
- Keep code snippets in Python/Psuedocode
|
|
|
|
|
- For language specific concepts, make sure to contrast it with other languages
|
|
|
|
|
- Use LaTeX math mode when possible.
|
|
|
|
|
Quick References:
|
|
|
|
|
- https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference
|
|
|
|
|
- https://jojozhuang.github.io/blog/2018/09/11/mathjax-cheat-sheet-for-mathematical-notation/
|
|
|
|
|
- Soft resize images to appropriate size (use html img tag with inline style)
|
|
|
|
|
- Use spaces instead of tabs (important, to keep indentation in code blocks consistent)
|
|
|
|
|
- Clearly mark the begin and end of each topic / question by using HR. markdown syntax: `-- --` on a new line
|
2019-10-10 17:11:38 +05:30
|
|
|
- Use _Italics_ minimally (hard to detect). Use **bold** and headings instead.
|
|
|
|
|
- Don't use H1
|
|
|
|
|
- Use the following syntax for H2 instead of the usual `# heading 2`
|
|
|
|
|
```md
|
|
|
|
|
Heading 2
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
content
|
|
|
|
|
```
|
