diff options
Diffstat (limited to 'languages/markdown.md')
| -rw-r--r-- | languages/markdown.md | 83 |
1 files changed, 50 insertions, 33 deletions
diff --git a/languages/markdown.md b/languages/markdown.md index 9e0b822..36a1136 100644 --- a/languages/markdown.md +++ b/languages/markdown.md @@ -1,39 +1,35 @@ # 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.` +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.` will autocorrect to the next corresponding number being "2." +9999. `9999.` or any number will autocorrect to the next corresponding number being "2." in this case. -- to make (unordered) list use a hyphen `-` to make a bullet -* 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.` ... +- 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` or type html's ` ` / ` ` + 1. Depending on what level using a number (ordered list) `1.` ... 2. could have mixed results `2.` - [ ] A task list can be created with `- [ ]` -- [x] and marked/ticked with `- [x]` -<ul> - <li>1993 the first version of HTML was written by Tim Berners-Lee </li> +- [x] And marked/ticked with `- [x]` -```html -<ul> - <li>'number' use html if unordered list starts with a number</li> -``` +<ul> + <li> 1, 2, 3 or any number in an unordered list use html: </li></ul> +`<ul>` + `<li>` "number" `</li></ul>` -`*` *use asterisks around text to make it italic* `*` +`*` *Use asterisks around text to make it italic* `*` -`**` **use two asterisks around text to make it bold** `**` +`**` **Use two asterisks around text to make it bold** `**` -`~~` ~~use two tildes around text to make a stikethrough (cancel out)~~ `~~` +`~~` ~~Use two tildes around text to make a stikethrough (cancel out)~~ `~~` - -to place emojis use `:joy:` :joy: +To place emojis use two colons around the emoji's name `:joy:` :joy: You might of noticed already the use of inline code being used like this ` `, we use backticks with "code/text" inbetween ` `` ` @@ -50,19 +46,40 @@ 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 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 +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 rules can be made with three or more hyphens, asterisks or underscores. Recommend using spaces inbetween. + +`- - -` +- - - | to | make | table | | --- | --- | --- | | use | three | hyphens | @@ -80,12 +97,11 @@ term [//]: # "[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](https://so-much-pain.glitch.me/do-a-barrel-roll.html) `[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 +The normal syntax to add an image is: ``` - + ``` or for windows: ``` @@ -93,7 +109,7 @@ or for windows: ``` else if for remote link: ``` - + ``` To add image with specified scaling try using some html since some attibutes of styling aren't supported by sites like Github: ```html @@ -101,5 +117,6 @@ To add image with specified scaling try using some html since some attibutes of ``` <img src="https://velog.velcdn.com/images/zmdlw/post/eb240f7b-ee94-49ae-8c22-b35873db6dc0/image.jpg" width="400" /> -Here's a sentence with a footnote. [^1] -[^1]: This is the footnote. +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. |