mirror of
https://github.com/dholerobin/Lecture_Notes.git
synced 2025-03-16 14:19:58 +00:00
Update README.md
This commit is contained in:
parent
8687e577a9
commit
ebe15af063
@ -15,3 +15,12 @@ Guidelines:
|
|||||||
- Soft resize images to appropriate size (use html img tag with inline style)
|
- 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)
|
- 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
|
- Clearly mark the begin and end of each topic / question by using HR. markdown syntax: `-- --` on a new line
|
||||||
|
- 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
|
||||||
|
```
|
||||||
|
Loading…
x
Reference in New Issue
Block a user