Skip to content

Commit 1889b7c

Browse files
committed
Update markdown.mdx based on issue #242
1 parent 093548f commit 1889b7c

File tree

1 file changed

+102
-0
lines changed

1 file changed

+102
-0
lines changed
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Markdown Basics
2+
3+
Markdown is a lightweight markup language that helps you create formatted text using a plain-text editor. Learn how to use Markdown to write content for your Fern documentation.
4+
5+
## Basic Syntax
6+
7+
### Text Formatting
8+
```md
9+
**bold text**
10+
*italic text*
11+
~~strikethrough text~~
12+
```
13+
14+
### Lists
15+
```md
16+
- Unordered list item
17+
- Another item
18+
- Nested item
19+
20+
1. Ordered list item
21+
2. Another item
22+
1. Nested item
23+
```
24+
25+
### Links
26+
```md
27+
[Link text](url)
28+
```
29+
30+
### Images
31+
```md
32+
![Alt text](path/to/image.png)
33+
```
34+
35+
To prevent an image from being zoomable, use the `noZoom` attribute:
36+
```md
37+
<img src="path/to/image.png" alt="Alt text" noZoom />
38+
```
39+
40+
### Code Blocks
41+
````md
42+
```javascript
43+
const hello = "world";
44+
console.log(hello);
45+
```
46+
````
47+
48+
### Tables
49+
```md
50+
| Header 1 | Header 2 |
51+
|----------|----------|
52+
| Cell 1 | Cell 2 |
53+
```
54+
55+
### Headings
56+
```md
57+
# Heading 1
58+
## Heading 2
59+
### Heading 3
60+
```
61+
62+
## Component Usage
63+
64+
### Tabs
65+
```md
66+
<Tabs>
67+
<Tab title="JavaScript">
68+
JavaScript content
69+
</Tab>
70+
<Tab title="Python">
71+
Python content
72+
</Tab>
73+
</Tabs>
74+
```
75+
76+
### Callouts
77+
```md
78+
<Info>
79+
Important information for users
80+
</Info>
81+
82+
<Warning>
83+
Critical warning message
84+
</Warning>
85+
```
86+
87+
### Cards
88+
```md
89+
<Cards>
90+
<Card title="Getting Started" href="/getting-started">
91+
Begin your journey with Fern
92+
</Card>
93+
</Cards>
94+
```
95+
96+
## Advanced Tips
97+
98+
- Use relative links when linking to other documentation pages
99+
- Keep paragraphs concise and focused
100+
- Include code examples when explaining technical concepts
101+
- Use headers to organize content logically
102+
- Leverage Fern components for enhanced formatting

0 commit comments

Comments
 (0)