srdusr
aboutsummaryrefslogtreecommitdiffstats
path: root/languages/markdown.md
blob: 206208e362739776e8853898c505701508e74be1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# header/title `#`
## sub heading `##` or `###...` for even smaller headers
This is a normal body of text and to go the next line we need to  
press space twice or `tab` and then enter `<CR>`  
1. To make ordered list use a number and punctuation mark `1.`  

9999. `9999.` or any number will autocorrect to the next corresponding number being "2." in this case.  

- For an unordered list use a hyphen `-` to make a bullet.  
* An asterisk `*` could also be used.  
+ Or a plus sign `+`  
  - Indent by using 2 spaces or `Tab`  
    1. Depending on what level using a number (ordered list) `1.` ...  
    2. could have mixed results `2.`  
&nbsp;1. To show a number first after indent use html's `&nbsp;` / `&emsp;` space symbols  

- [ ] A task list can be created with `- [ ]`  

- [x] And marked/ticked with `- [x]`  

`*` *Use asterisks around text to make it italic* `*`

`**` **Use two asterisks around text to make it bold** `**`

`~~` ~~Use two tildes around text to make a stikethrough (cancel out)~~ `~~`

`<u>` <u>Underline text with HTML's underline tags</u> `</u>`
NOTE: Can't underline text with this method in some instances like Github.

To place emojis use two colons around the emoji's name `:joy:` :joy:

<font color='#af00d7'>`<font color='color'>` Add color to font `</font>`</font>  
NOTE: Can't show color text in some instances like Github.

You might of noticed already the use of inline code being used like this ` `, we
use backticks with "code/text" inbetween ` `` `. We can also use HTML's keyboard input tag `<kbd>Ctrl</kbd>` to specifically show a keyboard button , example: <kbd>Ctrl</kbd>  


```
  ```Use 2 sets of three backticks to make a block of code```
```
```html
<p>for specific language syntax highlighting (this is html btw)...</p>
```
```python
print(" ```python
use three backticks followed by the name of the language
``` " # and three backticks again)
```

> To make a blockquote use greater-than sign aka "chevron" or "angle bracket" at the beginning `>`
>> Can also nest with `>>`

To comment out text we use `[//]: # ` followed by `"text to comment out"`  
Try viewing this in a raw format and through a parser to spot any differences.


[//]: # "lanigiro taht ton m'I esuaceb txet esrever emos tsuJ"

For definitions use:
```
term
: definition
```
Backslash escape characters that are available:
```
\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+   plus sign
-   minus sign (hyphen)
.   dot
!   exclamation mark  
```

Horizontal Rule can be made with three or more hyphens, asterisks or underscores. Recommend using spaces inbetween `- - -`  
- - -
A partial horizontal rule can be made by using HTML's horizontal rule `<hr>` tags  
```
<hr style ="border: `n`px `color`; width:`n`%;"></hr>

```
Where \`n\` before px (pixels) is a decimal (example: 0.8px) and \`n\` in width is a percentage (example: 80%). \`color\` (example: normal | green)  
<hr style="border: 0.8px normal; width:80%;"></hr>  

| to | make | table |
| --- | --- | --- |
| use | three | hyphens |
| after | the | title(s) |
| automatic | zebra | striping |

```
| to | make | table |
| --- | --- | --- |
| use | three | hyphens |
| after | the | title(s) |
| automatic | zebra | striping |
```

[//]: # "[this is a description for a link](https://github.com/srdusr/notes/blob/main/languages/markdown.md) `[description](url)`"


[this is a description for a link with optional title/alt text](https://fwesh.yonle.repl.co/ "Rick Roll") `[description](url/ "title")`

The normal syntax to add an image is:
```
![title](path/to/example.jpg "Optional title")
```
or for windows:
```
![image](files://C:/Users/username/Desktop/example.png)
```
else if for remote link:
```
![Alt text](url)
```
To add image with specified scaling try using some html since some attibutes of styling aren't supported by sites like Github:
```html
<img src="http://....jpg" width="400" height="400" />
```
<img src="https://velog.velcdn.com/images/zmdlw/post/eb240f7b-ee94-49ae-8c22-b35873db6dc0/image.jpg" width="400" />

To create a footnote, add a caret symbol inside the square brackets followed by the same number to be used `[^1]` [^1]
[^1]: `[^1]:` Over here just add a colon before what ever reference/notes are
  going to be specified.