Skip to content

Commit a1b4968

Browse files
authored
Update make-a-github-readme.mdx
1 parent 517b24d commit a1b4968

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

projects/make-a-github-readme/make-a-github-readme.mdx

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,35 @@ Some things you can highlight:
5959
- Fun fact about yourself
6060
- Anything you want!
6161

62-
READMEs are primarily written with **Markdown** – it's a way to format plain text and turn it into things like headers, formatted text (bold, italics, underlines), lists, or links!
62+
READMEs are primarily written with **Markdown** – it's a simple language to format plain text and turn it into things like headers, formatted text (bold, italics, underlines), lists, or links!
6363

6464
Here's a quick guide on how to mark down your text:
6565

66-
- **Headers:** `# Header 1` (add more #s to get smaller headers)
66+
### Headers
67+
68+
You can kick off the file with a H1 heading with a single `#`:
69+
70+
```markdown
71+
# Hello, World! 🌎 I'm Gabby 👋
72+
```
73+
74+
### Lists
75+
76+
Put an asterisk (*), dash (-), or number (1.) before each list item. Each option creates bullet points, dashed lists, and numbered lists, respectively.
77+
78+
```markdown
79+
currently:
80+
- curriculum @ marketing @ codédex
81+
- graphic information technlogoy @ arizona state
82+
- MLH Top 50!
83+
- hackNY '25
84+
```
85+
86+
### Links
87+
6788
- **Links:** `(Google)[https://google.com]`
6889
- **Images:** `![](https://images.com/cat_img.PNG)`
6990
- **Highlighting code:** ````<script> //code here </script>````
70-
- **Lists:** Put an asterisk (*), dash (-), or number (1.) before each list item. Each option creates bullet points, dashed lists, and numbered lists, respectively.
7191

7292
## Personalizing the README
7393

0 commit comments

Comments
 (0)