10000 GitHub - abdullahdangac/Markdown-Notes: Markdown notes and cheat sheet.
[go: up one dir, main page]
Skip to content

abdullahdangac/Markdown-Notes

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
README.md
README.md
 
 

Repository files navigation

Markdown Notes

CONTENTS

1. TEXT
  1.1. Header
  1.2. Space
  1.3. Line Break
  1.4. Styling Text
  1.5. Aligning Text
  1.6. List Text
  1.7. Quote Text
  1.8. Collapsed Section
  1.9. Alerts
  1.10. Hiding Content

2. CODE
  2.1. Inline Code
  2.2. Code Block

3. LINK
  3.1. Text Link
  3.2. Image as Link
  3.3. Section Link
  3.4. Reference Link

4. IMAGE
  4.1. Resizing Image
  4.2. Aligning Image

5. TABLE
  5.1. Aligning Text in Table
  5.2. Side by Side Tables

6. MATHEMATICAL EXPRESSION
  6.1. Inline Mathematical Expression
  6.2. Mathematical Expression Block
  6.3. Arithmetic Expressions
  6.4. Equality Expressions
  6.5. Comparison Expressions
  6.6. Algebra Expressions
  6.7. Angle Expressions
  6.8. Probability & Statistics
  6.9. Complex Numbers
  6.10. Linear Algebra: Vectors
  6.11. Linear Algebra: Matrices
  6.12. Calculus Expressions
  6.13. Greek Alphabet





1. TEXT

1.1. Header

# H1 (Biggest)
## H2 
### H3 
#### H4 
##### H5 
###### H6 (Smallest)

H1 (Biggest)

H2

H3

H4

H5
H6 (Smallest)


1.2. Space

   to add a single space.
   to add 2 spaces.
   to add 4 spaces.

Example

No space  
 1 space  
 2 spaces  
 4 spaces

No space
 1 space
 2 spaces
 4 spaces



1.3. Line Break

An .md file, would render on one line without a line break.

Markdown
Notes

Markdown Notes


To create a line break in an .md file, you will need to include one of the following:

  • Include two spaces at the end of the first line.

    Markdown<space><space>
Notes

    Markdown
    Notes

  • Include a backslash at the end of the first line.

    Markdown\
Notes

    Markdown
    Notes

  • Include an HTML single line break tag at the end of the first line.

    Markdown<br/>
Notes

    Markdown
    Notes

If you leave a blank line between two lines, both .md files and Markdown will render the two lines separated by the blank line:

Markdown

Notes

Markdown

Notes



1.4. Styling Text

Style Syntax Example Output
Bold ** ** or __ __ **Bold** Bold
Italic * * or _ _ _Italic_ Italic
Strike-through ~~ ~~ or ~ ~ ~Strike-through~ Strike-through
Bold and Italic *** *** ***Bold and Italic*** Bold and Italic
Underline <ins> </ins> <ins>Underline</ins> Underline
Subscript <sub> </sub> A <sub>subscript</sub> text A subscript text
Superscript <sup> </sup> A <sup>superscript</sup> text A superscript text


1.5. Aligning Text

<p align="left">Left-aligned text</p>  
<p align="center">Center-aligned text</p>  
<p align="right">Right-aligned text</p>

Left-aligned text

Center-aligned text

Right-aligned text



1.6. List Text

- Element

+ Element

* Element
  • Element
  • Element
  • Element

1.6.1. Bullet List

- Element 1
- Element 2
  - Sub-element 1
    - Sub-element 1.a
  • Element 1
  • Element 2
    • Element 2.1
      • Element 2.1.a

1.6.2. Ordered List

1. Element 1
2. Element 2
   1. Sub-element 1
      1. Sub-element 1.a
  1. Element 1
  2. Element 2
    1. Element 2.1
      1. Element 2.1.a

1.6.3. Task List

- [x] Completed
- [ ] Not completed
  • Completed
  • Not completed


1.7. Quote Text

> This is a quote.

This is a quote.



1.8. Collapsed Section

<details>
<summary>Collapsed section</summary>

Text in collapsed section.

</details>
Collapsed section

Text in collapsed section.



1.9. Alerts

> :memo: **NOTE**: Useful information that users should know, even when skimming content.

> :bulb: **TIP**: Helpful advice for doing things better or more easily.

> :warning: **WARNING**: Urgent info that needs immediate user attention to avoid problems.

> :heavy_check_mark: **CHECK MARK**: Used to indicate when an action is complete or that something is correct.

📝 NOTE: Useful information that users should know, even when skimming content.

💡 TIP: Helpful advice for doing things better or more easily.

⚠️ WARNING: Urgent info that needs immediate user attention to avoid problems.

✔️ CHECK MARK: Used to indicate when an action is complete or that something is correct.


There is another use for GitHub:

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.



1.10. Hiding Content

This content will appear in the rendered Markdown
<!-- This content will not appear in the rendered Markdown -->

this content will appear in the rendered Markdown





2. CODE

2.1. Inline Code

This is `inline code` example.

This is inline code example.


2.2. Code Block

```code-language
Code Block
```

Example

Markdown text

```cpp
#include <iostream>

int main()
{
  // some code
  return 0;
}
```

Output

#include <iostream>

int main()
{
  // some code
  return 0;
}




3. LINK

3.1. Text Link

[Link Text](URL "Title")

Example

[Markdown Notes](https://github.com/abdullahdangac/Markdown-Notes "Markdown Notes")

Markdown Notes


3.2. Images as Link

[![Image Alt Text](image-url.jpg)](hyperlink-url)

Example

Icon

[![LinkedIn](https://i.sstatic.net/gVE0j.png)](https://www.linkedin.com/in/abdullahdangac "LinkedIn Profile")

LinkedIn


Badge

[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/abdullahdangac/)

LinkedIn


Tip

You can find some Markdown badges here.


3.3. Section Link

### Sample Section

#### Sample Subsection

Link to the Sample Section: [Link Text](#sample-section)  
Link to the Sample Subsection: [Link Text](#sample-subsection)


### This'll be a _Helpful_ Section About the Greek Letter (e.g. β)!
A heading containing characters not allowed in fragments, UTF-8 characters, two
consecutive spaces between the first and second words, and formatting.

Link to the helpful section: [Link Text](#thisll-be-a-helpful-section-about-the-greek-letter-e.g.-β).

Sample Section

Sample Subsection

Link to the Sample Section: Link Text
Link to the Sample Subsection: Link Text


This'll be a Helpful Section About the Greek Letter β!

A heading containing characters not allowed in fragments, UTF-8 characters, two consecutive spaces between the first and second words, and formatting.

Link to the helpful section: Link Text


3.4. Reference Link

Use link as [reference-style][reference link text] with new link title.  
Or leave title empty and use the [reference link text] itself.

[reference link text]: https://www.somewebsite.org

Use link as reference-style with new link title.
Or leave title empty and use the reference link text itself.

Example

[CMake] :  an open source, cross-platform family of tools designed to build, test, and package software.  
[C++ Reference][cppreference.com] :  a reference guide for C++ programming language.
  
[CMake]: https://cmake.org/
[cppreference.com]: https://en.cppreference.com

CMake is an open source tool designed to build, test and package software.
C++ Reference is a reference guide for C++ programming language.





4. IMAGE

![Alt Text](image-url.jpg "Image Title")

Example

![Markdown Mark](https://github.com/dcurtis/markdown-mark/blob/master/png/208x128.png)

Markdown Mark


4.1. Resizing Image

Resize with pixel

<img src="image_name.png" alt="Alt Text" width=300 height=450 title="Image Title"/>

Resize with scaling percent

<img src="image_name.png" alt="Alt Text" width="50%" height="50%" title="Image Title"/>

Example

<img src="https://github.com/dcurtis/markdown-mark/blob/master/png/208x128.png" width=104 height=64/>

<img src="https://github.com/dcurtis/markdown-mark/blob/master/png/208x128.png" width=10.5% height=10.5%/>


4.2. Aligning Image

<p align="align-type">
  <img src="image_name.png" alt="Alt Text" width="50%" height="50%" title="Image Title"/>
</p>

Example

<p align="left">
  <img src="https://github.com/dcurtis/markdown-mark/blob/master/png/208x128.png" width=10.5% height=10.5%/>
</p>

<p align="center">
  <img src="https://github.com/dcurtis/markdown-mark/blob/master/png/208x128.png" width=10.5% height=10.5%/>
</p>

<p align="right">
  <img src="https://github.com/dcurtis/markdown-mark/blob/master/png/208x128.png" width=10.5% height=10.5%/>
</p>





5. TABLE

|A |B |C |
|--|--|--|
|1 |2 |3 |
|4 |5 |6 |
|7 |8 |9 |
A B C
1 2 3
4 5 6
7 8 9

5.1. Aligning Text in Table

| Left-aligned | Center-aligned | Right-aligned |
|:-------------|:--------------:|--------------:|
| Text         | Text           | Text          |
| Text         | Text           | Text          |
Left-aligned Center-aligned Right-aligned
Text Text Text
Text Text Text
  • :-- means the column is left aligned.
  • --: means the column is right aligned.
  • :-: means the column is center aligned.

5.2. Side by Side Tables

<table>
<tr><th>First Table</th><th>Second Table</th></tr>
<tr><td>

|A    |B    |C    |D    |
|:---:|:---:|:---:|:---:|
|0    |1    |2    |3    |
|7    |8    |9    |10   |

</td><td>
  
|E    |F    |G    |
|:---:|:---:|:---:|
|4    |5    |6    |
|11   |12   |13   |

</td></tr>
</table>
First TableSecond Table
A B C D
0 1 2 3
7 8 9 10
E F G
4 5 6
11 12 13




6. MATHEMATICAL EXPRESSION

6.1. Inline Mathematical Expression

$\sqrt{3x-1}+(1+x)^2$

$\sqrt{3x-1}+(1+x)^2$


6.2. Mathematical Expression Block

$$
\sqrt{3x-1}+(1+x)^2
$$

$$ \sqrt{3x-1}+(1+x)^2 $$

```math
\sqrt{3x-1}+(1+x)^2
```
$$\sqrt{3x-1}+(1+x)^2$$

6.3. Arithmetic Expressions

Notation Example Markdown Format
Addition $x+y$ $x+y$
Subtraction $x-y$ $x-y
Multiplication $x \times y$
$x \ast y$
$x \cdot y$ 		$x \times y$
$x \ast y$
$x \cdot y$
Division $x \colon y$
$x / y$
$x \div y$
$\frac{x}{y}$ 		$x \colon y$
$x / y$
$x \div y$
$\frac{x}{y}$
Remainder / Modulo $x \mod y$ $x \mod y$
Negative Value $-x$ $-x$
Plus or Minus
Minus or Plus		 $\pm x$
$\mp x$ 		$\pm x$
$\mp x$
Squared
Cubed
nth-Power		 $x^2$
$x^3$
$x^n$ 		$x^2$
$x^3$
$x^n$
Square Root
Cube Root
nth-Root		 $\sqrt{x}$
$\sqrt[3]{x}$
$\sqrt[n]{x}$ 		$\sqrt{x}$
$\sqrt[3]{x}$
$\sqrt[n]{x}

6.4. Equality Expressions

Notation Example Markdown Format
Equals $x=y$ $x=y$
Not Equals $x \neq y$ $x \neq y$
Identical / Equivalent To $x \equiv y$ $x \equiv y$
Proportional To $x \propto y$ $x \propto y$
Approximately Equal To $x \approx y$ $x \approx y$

6.5. Comparison Expressions

Notation Example Markdown Format
Less Than
Greater Than		 $a&lt;b$
$a&gt;b$ 		$a<b$
$a>b$
Less Than or Equal
Greater Than or Equal		 $a \leq b$
$a \geq b$ 		$a \leq b$
$a \geq b$
Much Smaller Than
Much Larger Than		 $a \ll b$
$a \gg b$ 		$a \ll b$
$a \gg b$

6.6. Algebra Expressions

Notation Example Markdown Format
Factorial $x!$ $x!$
Absolute Value $|-x|$ $|-x|$
Function $f(x)$ $f(x)$
Change or Difference $\Delta x = x_1 - x_0$ $\Delta x = x_1 - x_0$
Pi $\pi = 3.14159 \ldots$ $\pi = 3.14159...$
Euler’s Constant $e = 2.71828 \ldots$ $e = 2.71828...$
Sum $\displaystyle\sum_{k=0}^n k$ $\displaystyle\sum_{k=0}^n k$
Series Product $\displaystyle\prod_{x=0}^n x$ $\displaystyle\prod_{x=0}^n x$
Brackets
Parentheses		 $[\ldots]$
$(\ldots)$ 		$[...]$
$(...)$

6.7. Angle Expressions

Notation Example Markdown Format
Angle $\angle$ $\angle$
Degree, Arc Min, Arc Sec $30\degree 45' 30''$ $30\degree 40\rq 50\rq\rq$
Radians $2\pi rad$ $2\pi rad$

6.8. Probability & Statistics

Notation Example Markdown Format
Probability of Event A $P(A)$ or $\Pr(A)$ $P(A)$ or $\Pr(A)$
Intersection Prob. of A & B $P(A \cap B)$ $P(A \cap B)$
Union Prob. of A or B $P(A \cup B)$ $P(A \cup B)$
Conditional Prob. of A Given B $P(A|B)$ $P(A|B)$
Median $\tilde{x}$ $\tilde{x}$
Population Mean $\mu$
$\overline{x}$
$\langle x \rangle$ 		$\mu$
$\overline{x}$
$\langle x \rangle$
Standard Deviation $\sigma$ $\sigma$
Varience $\sigma^2$ $\sigma^2$

6.9. Complex Numbers

Notation Example Markdown Format
Imaginary Unit i $z = a + bi$ $z = a + bi$
Real Part Of Complex Number $\text{Re}(z)=a$ $\text{Re}(z) = a$
Imaginary Part Of Complex Number $\text{Im}(z)=b$ $\text{Im}(z) = b$
Complex Conjugate $\bar{z}=z^*=a-bi$ $\bar{z} = z^* = a - bi$

6.10. Linear Algebra: Vectors

Notation Example Markdown Format
Vectors $\mathbf{v}$
$\overline{v}$
$\vec{v}$ 		$\mathbf{v}$
$\overline{v}$
$\vec{v}$
Dot Product $\mathbf{v} \cdot \mathbf{w}$
$(v,w)$
$\left&lt;v | w\right&gt;$ 		$\mathbf{v} \cdot \mathbf{w}$
$(v,w)$
$\left< v | w \right>$
Cross Product $v \times w$ $v \times w$
Length of v $|v|$ $|v|$
Norm of v $||v||$ $||v||$

Row Vector

$$
v = \begin{pmatrix}
1 & 2 & 3
\end{pmatrix}
$$

$$ v = \begin{pmatrix} 1 & 2 & 3 \end{pmatrix} $$

Column Vector

$$
w = \begin{pmatrix}
4 \\
5 \\
6 \\
\end{pmatrix}
$$

$$ w = \begin{pmatrix} 4 \\ 5 \\ 6 \\ \end{pmatrix} $$


6.11. Linear Algebra: Matrices

Notation Example Markdown Format
Product $A \cdot B$ $A \cdot B$
Hadamard Product $A \circ B$ $A \circ B$
Kronecker Product $A \otimes B$ $A \otimes B$
Transposed Matrix $A^T$ $A^T$
Conjugate Transpose $A^\ast$ $A^\ast$
Inverse Matrix $A^{-1}$ $A^{-1}$
Determinant $|A|$ $|A|$
Norm $||A||$ $||A||$

Matrix

$$
A = \begin{bmatrix}
1 & 2 & 3 \\
4 & 5 & 6
\end{bmatrix}
$$

$$ A = \begin{bmatrix} 1 & 2 & 3 \\ 4 & 5 & 6 \end{bmatrix} $$


6.12. Calculus Expressions

6.12.1. Partial Function

$$
f(x) = \begin{cases}
x & \text{if } a>b \\
y & \text{if } c>d
\end{cases}
$$

$$ f(x) = \begin{cases} x & \text{if } a>b \\ y & \text{if } c>d \end{cases} $$

6.12.2. Integration

$$
\int_{a}^{b} dx
$$

$$ \int_{a}^{b} dx $$

6.12.3. Differentiation

First Derivative

$$
\frac{df}{dx}
$$

$$ \frac{df}{dx} $$

Partial Derivative

$$
\frac{\partial f}{\partial x}
$$

$$ \frac{\partial f}{\partial x} $$

First and Second Derivative of Function

$$
f\rq
f\rq\rq
$$

$$ f' \ \ \ \ f'' $$

First and Second Derivative With Respect To Time

$$
\dot f
\ddot f
$$

$$ \dot f \ \ \ \ \ddot f $$


6.13. Greek Alphabet

Letter Lower Markdown Format Upper Markdown Format
Alpha $\alpha$ $\alpha$ $\text{A}$ $\Alpha$
Beta $\beta$ $\beta$ $\text{B}$ $\Beta$
Gamma $\gamma$ $\gamma$ $\Gamma$ $\Gamma$
Delta $\delta$ $\delta$ $\Delta$ $\Delta$
Epsilon $\epsilon$ $\epsilon$ $\text{E}$ $\Epsilon$
Zeta $\zeta$ $\zeta$ $\text{Z}$ $\Zeta$
Eta $\eta$ $\eta$ $\text{H}$ $\Eta$
Theta $\theta$ $\theta$ $\Theta$ $\Theta$
Iota $\iota$ $\iota$ $\text{I}$ $\Iota$
Kappa $\kappa$ $\kappa$ $\text{K}$ $\Kappa$
Lambda $\lambda$ $\lambda$ $\Lambda$ $\Lambda$
Mu $\mu$ $\mu$ $\text{M}$ $\Mu$
Nu $\nu$ $\nu$ $\text{N}$ $\Nu$
Xi $\xi$ $\xi$ $\Xi$ $\Xi$
Omicron $\omicron$ $\omicron$ $\text{O}$ $\Omicron$
Pi $\pi$ $\pi$ $\Pi$ $\Pi$
Rho $\rho$ $\rho$ $\text{P}$ $\Rho$
Sigma $\sigma$ $\sigma$ $\Sigma$ $\Sigma$
Tau $\tau$ $\tau$ $\text{T}$ $\Tau$
Upsilon $\upsilon$ $\upsilon$ $\Upsilon$ $\Upsilon$
Phi $\phi$ $\phi$ $\Phi$ $\Phi$
Chi $\chi$ $\chi$ $\text{X}$ $\Chi$
Psi $\psi$ $\psi$ $\Psi$ $\Psi$
Omega $\omega$ $\omega$ $\Omega$ $\Omega$

About

Markdown notes and cheat sheet.

Topics

markdown markdown-cheatsheet markdown-language markdown-note markdown-notes

Resources

Readme
Activity

Stars

2 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published
0