https://github.com/nabin-8/markdown-guide
https://github.com/nabin-8/markdown-guide
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nabin-8/markdown-guide
- Owner: nabin-8
- Created: 2024-01-13T12:08:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-15T15:43:51.000Z (over 1 year ago)
- Last Synced: 2024-02-15T16:51:53.010Z (over 1 year ago)
- Size: 42 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Markdown Guide
## Table of Contents
|No| Content | link |No| Content | link |
|---| ---| ---|---| ---| ---|
|1.| Hedings| [click](#hedings) |7.| Quoting code| [click](#quoting-code)|
|2.| Styling text| [click](#styling-text)|8.| Link| [click](#link)|
|3.| List| [click](#list)|9.| Images| [click](#images)|
|4.| Table| [click](#table)|10.|Mermaid|[click](#mermaid)|
|5.| Highlight| [click](#highlight)|
|6.| Horizontal line| [click](#horizontal-line)|
---
### Hedings
`# A first-level heading`
`## A second-level heading`
`### A third-level heading`
>1. # A first-level heading
>1. ## A second-level heading
>1. ### A third-level heading
---
### Styling text
| style |Example| syntax |
|---| ---| ---|
|**Bold**|`**To Make Bold Use**`| `**`|
|*Italic*|`*To Make Italic Use*`| `*`|
|~~Strikethrough~~|`~~To make Strikethrough Use~~`| `~~` |
|**To make Nested Bold and *italic* Use**|`**To make Nested Bold and *italic* Use**` |`* **` |
---
### List
ordert list
`1. one`
`1. two`
`1. three`
1. one
1. two
1. three
unordert list
`- one`
`- two`
`- three`
- one
- two
- three
---
### Table
```
| syntex | description|
| ---| ---|
| title| description|
```
| syntex | description|
| ---| ---|
| title| description|
---
### Highlight
> To highlight you can use Blockquotes >
`#RRGGBB`
```
To highlight multiple things you can use
```
> To highlight you can use
`#RRGGBB`
```
To highlight multiple things you can use
```
---
### Horizontal line
You can use `---` 3 hyphen
---
### Quoting code
**JavaScript Program**
```javascript
console.log("hello");
//this is js code
```
```javascript
console.log("hello");
//this is js code
```
**C Program**
```c
#include
int main(){
printf("Hello World!);
return 0;
}
```
```c
#include
int main(){
printf("Hello World!);
return 0;
}
```
---
### Link
`[ref](link)`
`[Table of Content](#table-of-contents)`
`[YouTube](https://www.youtube.com/)`
[Table of Content](#table-of-contents)
[YouTube](https://www.youtube.com/)
---
### Images
``
``
---
---
## Mermaid
With Mermaid You can make
- Graph
- Roadmaps
- Shapes
- Flow
- Gantt Chart
Let's Lern the basics
### Graph
Diagram
```mermaid
flowchart TD
A-->B
```
*Code*
```mermaid
flowchart
A-->B
```
Possible directions are:
- TB - top bottom
- BT - bottom top
- RL - right left
- LR - left right
- TD - same as TB
|Diagram |*Code*|Diagram|*Code*|
|---|---|---|---|
||TB ||RL |
||BT ||LR |
### Roadmaps
Diagram
```mermaid
flowchart
A((md Guide))
A--->B((mermaid))
A--->C((Flow Chart))
A--->D((Gantt Chart))
A--->E((Graph))
```
*Code*
```mermaid
flowchart
A((md Guide))
A--->B((mermaid))
A--->C((Flow Chart))
A--->D((Gantt Chart))
A--->E((Graph))
```
### Shapes
```mermaid
flowchart
Rectangle
```
*Code*
```mermaid
flowchart
Rectangle
```
```mermaid
flowchart
A(Rectangle Round Edges)
```
*Code*
```mermaid
flowchart
A(Rectangle Round Edges)
```
```mermaid
flowchart
A((__Circle__))
```
*Code*
```mermaid
flowchart
A((Circle))
```
```mermaid
flowchart
A>Asymmetric]
```
*Code*
```mermaid
flowchart
A>Asymmetric]
```
```mermaid
flowchart
A{Rhombus}
```
*Code*
```mermaid
flowchart
A{Rhombus}
```
### Gantt Chart
```mermaid
gantt
title Gantt Diagram
dateFormat YYYY-MM-DD
section Section
First Task :a1, 2024-01-01, 30d
Another Task :after a1, 20d
section Another
Second Task :2024-01-12, 12d
Third Task : 24d
```
*code*
```mermaid
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
section Section
First Task :a1, 2018-07-01, 30d
Another Task :after a1, 20d
section Another
Second Task :2018-07-12, 12d
Third Task : 24d
```