-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathhow-to-readme
155 lines (85 loc) · 2.1 KB
/
how-to-readme
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
Markdown is a lightweight markup language that allows you to format text using plain text syntax. Here are 15 Markdown features with examples:
Headers:
Use # for headers. More # means a smaller header.
markdown
# H1 Header
## H2 Header
### H3 Header
#### H4 Header
##### H5 Header
###### H6 Header
Bold Text:
Surround text with ** or __ for bold.
markdown
**Bold Text**
__Bold Text__
Italic Text:
Surround text with * or _ for italic.
markdown
*Italic Text*
_Italic Text_
Strikethrough:
Use ~~ to strike through text.
markdown
~~Strikethrough Text~~
Blockquote:
Use > to create a blockquote.
markdown
> This is a blockquote.
Lists:
Use -, *, or + for unordered lists. Use numbers for ordered lists.
markdown
- Item 1
- Item 2
- Subitem 2.1
- Subitem 2.2
1. First item
2. Second item
1. Subitem 2.1
2. Subitem 2.2
Code Blocks:
Use backticks for inline code. Use triple backticks for code blocks.
markdown
`Inline code`
```
def hello_world():
print("Hello, world!")`
```
Horizontal Rule:
Use ---, ***, or ___ to create a horizontal rule.
---
Links:
Use [link text](URL) for links.
markdown
[OpenAI](https://www.openai.com)
Images:
Use  for images.
markdown
Tables:
Use | to create tables.
markdown
| Header 1 | Header 2 |
|----------|----------|
| Cell 1 | Cell 2 |
| Cell 3 | Cell 4 |
Task Lists:
Use - [ ] for unchecked tasks and - [x] for checked tasks.
markdown
- [x] Task 1
- [ ] Task 2
Inline HTML:
Embed HTML directly within Markdown.
markdown
<div style="color: red;">This is red text</div>
Footnotes:
Use [^1] to add footnotes.
markdown
This is a sentence with a footnote.[^1]
[^1]: This is the footnote.
Emojis:
Use :emoji_name: to add emojis.
markdown
:smile: :rocket: :tada:
By using these features, you can create well-structured and visually appealing Markdown documents for your GitHub repositories or any other purpose where Markdown is supported.
courtesy of our friend chatGPT