Skip to content

Commit b97bf18

Browse files
committed
chore: sample doc
1 parent af34fc9 commit b97bf18

File tree

2 files changed

+366
-3
lines changed

2 files changed

+366
-3
lines changed

assets/test.png

1.04 MB
Loading

docs/intro.mdx

Lines changed: 366 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,370 @@
11
---
2-
a: b
2+
title: 'Comprehensive Markdown & MDX Formatting Test'
3+
description: 'A complete test of all markdown and MDX formatting features'
34
---
45

5-
# Test Doc
6+
# Comprehensive Markdown & MDX Formatting Test
67

7-
Hello, content!!!
8+
This document tests all major markdown formatting features and custom MDX components.
9+
10+
## Table of Contents
11+
12+
- [Headers](#headers)
13+
- [Text Formatting](#text-formatting)
14+
- [Lists](#lists)
15+
- [Links and Images](#links-and-images)
16+
- [Code](#code)
17+
- [Tables](#tables)
18+
- [Blockquotes](#blockquotes)
19+
- [Horizontal Rules](#horizontal-rules)
20+
- [Custom Components](#custom-components)
21+
- [HTML Elements](#html-elements)
22+
23+
## Headers
24+
25+
# H1 Header
26+
27+
## H2 Header
28+
29+
### H3 Header
30+
31+
#### H4 Header
32+
33+
##### H5 Header
34+
35+
###### H6 Header
36+
37+
## Text Formatting
38+
39+
**Bold text** and **also bold text**
40+
41+
_Italic text_ and _also italic text_
42+
43+
**_Bold and italic_** and **_also bold and italic_**
44+
45+
~~Strikethrough text~~
46+
47+
Regular text with `inline code` in the middle.
48+
49+
Text with super^script^ and sub~script~.
50+
51+
## Lists
52+
53+
### Unordered Lists
54+
55+
- First item
56+
- Second item
57+
- Nested item
58+
- Another nested item
59+
- Deep nested item
60+
- Third item
61+
62+
* Alternative bullet style
63+
* Second item
64+
- Mixed nested style
65+
- Another mixed item
66+
67+
### Ordered Lists
68+
69+
1. First ordered item
70+
2. Second ordered item
71+
1. Nested numbered item
72+
2. Another nested numbered item
73+
3. Third ordered item
74+
75+
### Task Lists
76+
77+
- [x] Completed task
78+
- [ ] Incomplete task
79+
- [x] Another completed task
80+
- [ ] Nested incomplete task
81+
- [x] Nested completed task
82+
83+
## Links and Images
84+
85+
### Links
86+
87+
[Regular link](https://example.com)
88+
89+
[Link with title](https://example.com 'Example Website')
90+
91+
[Reference link][1]
92+
93+
[1]: https://example.com 'Reference link example'
94+
95+
### Images
96+
97+
![Sample image](test.png)
98+
99+
## Code
100+
101+
### Inline Code
102+
103+
Here's some `inline code` and `const variable = "value"`.
104+
105+
### Code Blocks
106+
107+
```
108+
Plain code block without syntax highlighting
109+
const example = "no highlighting";
110+
```
111+
112+
```javascript
113+
// JavaScript code block
114+
function greetUser(name) {
115+
console.log(`Hello, ${name}!`);
116+
return `Welcome, ${name}`;
117+
}
118+
119+
const user = 'World';
120+
greetUser(user);
121+
```
122+
123+
```python
124+
# Python code block
125+
def calculate_fibonacci(n):
126+
if n <= 1:
127+
return n
128+
return calculate_fibonacci(n-1) + calculate_fibonacci(n-2)
129+
130+
# Generate first 10 fibonacci numbers
131+
for i in range(10):
132+
print(f"F({i}) = {calculate_fibonacci(i)}")
133+
```
134+
135+
```bash
136+
# Bash commands
137+
npm install package-name
138+
cd project-directory
139+
npm run build
140+
```
141+
142+
```json
143+
{
144+
"name": "test-project",
145+
"version": "1.0.0",
146+
"dependencies": {
147+
"react": "^18.0.0",
148+
"typescript": "^5.0.0"
149+
},
150+
"scripts": {
151+
"dev": "vite dev",
152+
"build": "vite build"
153+
}
154+
}
155+
```
156+
157+
```css
158+
/* CSS styling */
159+
.container {
160+
max-width: 1200px;
161+
margin: 0 auto;
162+
padding: 1rem;
163+
}
164+
165+
.header {
166+
background: linear-gradient(45deg, #667eea 0%, #764ba2 100%);
167+
color: white;
168+
padding: 2rem;
169+
border-radius: 8px;
170+
}
171+
```
172+
173+
```sql
174+
-- SQL queries
175+
SELECT users.name, users.email, COUNT(orders.id) as order_count
176+
FROM users
177+
LEFT JOIN orders ON users.id = orders.user_id
178+
WHERE users.created_at > '2024-01-01'
179+
GROUP BY users.id
180+
ORDER BY order_count DESC
181+
LIMIT 10;
182+
```
183+
184+
## Tables
185+
186+
### Simple Table
187+
188+
| Column 1 | Column 2 | Column 3 |
189+
| ----------- | ----------- | ----------- |
190+
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |
191+
| Row 2 Col 1 | Row 2 Col 2 | Row 2 Col 3 |
192+
193+
### Aligned Table
194+
195+
| Left Aligned | Center Aligned | Right Aligned |
196+
| :----------- | :------------: | ---------------: |
197+
| Left text | Center text | Right text |
198+
| More left | More center | More right |
199+
| Lorem ipsum | Dolor sit | Amet consectetur |
200+
201+
### Complex Table
202+
203+
| Feature | Status | Priority | Notes |
204+
| ------------------ | -------------- | -------- | ------------------------ |
205+
| **Authentication** | ✅ Complete | High | OAuth2 implemented |
206+
| _User Management_ | 🚧 In Progress | Medium | CRUD operations 80% done |
207+
| ~~Old Feature~~ | ❌ Deprecated | Low | Will be removed in v2.0 |
208+
| `API Endpoints` | ✅ Complete | High | RESTful design |
209+
210+
## Blockquotes
211+
212+
> This is a simple blockquote.
213+
214+
> This is a blockquote with multiple lines.
215+
> It continues on this line.
216+
> And this line too.
217+
218+
> **Blockquote with formatting**
219+
>
220+
> You can use _italic_, **bold**, and even `code` inside blockquotes.
221+
>
222+
> > This is a nested blockquote.
223+
> > It can contain multiple lines too.
224+
225+
> ### Blockquote with headers
226+
>
227+
> Even headers work inside blockquotes.
228+
>
229+
> - And lists
230+
> - Work too
231+
232+
## Horizontal Rules
233+
234+
Here's a horizontal rule:
235+
236+
---
237+
238+
And another style:
239+
240+
---
241+
242+
And yet another:
243+
244+
---
245+
246+
## HTML Elements
247+
248+
### Emphasis and Strong
249+
250+
<em>Emphasized text using HTML</em>
251+
252+
<strong>Strong text using HTML</strong>
253+
254+
<mark>Highlighted text</mark>
255+
256+
<del>Deleted text</del>
257+
258+
<ins>Inserted text</ins>
259+
260+
### Abbreviations and Definitions
261+
262+
<abbr title='HyperText Markup Language'>HTML</abbr> is the standard markup language.
263+
264+
<dfn>CSS</dfn> stands for Cascading Style Sheets.
265+
266+
### Keyboard and Code
267+
268+
Press <kbd>Ctrl</kbd> + <kbd>C</kbd> to copy.
269+
270+
The <code>console.log()</code> function outputs to the console.
271+
272+
<samp>This is sample computer output</samp>
273+
274+
<var>x</var> = <var>y</var> + 2
275+
276+
### Superscript and Subscript
277+
278+
E = mc<sup>2</sup>
279+
280+
H<sub>2</sub>O is the chemical formula for water.
281+
282+
### Small Text and Citations
283+
284+
<small>This is small print text.</small>
285+
286+
<q>This is a short inline quotation.</q>
287+
288+
<cite>The Great Gatsby</cite> by F. Scott Fitzgerald.
289+
290+
## Special Characters and Entities
291+
292+
Here are some special characters: © ® ™ € £ ¥ § ¶ † ‡ • …
293+
294+
Math symbols: ± × ÷ ≠ ≤ ≥ ∞ ∑ ∏ √ ∂ ∫
295+
296+
Arrows: ← → ↑ ↓ ↔ ↕ ↖ ↗ ↘ ↙
297+
298+
Greek letters: α β γ δ ε ζ η θ ι κ λ μ ν ξ ο π ρ σ τ υ φ χ ψ ω
299+
300+
## Line Breaks and Spacing
301+
302+
This is a line with two spaces at the end.
303+
This should be on a new line due to the line break.
304+
305+
This paragraph has a manual line break using HTML.<br />
306+
This line comes right after the break.
307+
308+
---
309+
310+
## Escape Characters
311+
312+
Here are some escaped characters:
313+
314+
\*This is not italic\*
315+
316+
\`This is not code\`
317+
318+
\# This is not a header
319+
320+
\[This is not a link\](example.com)
321+
322+
## Edge Cases
323+
324+
### Empty Elements
325+
326+
Here's an empty blockquote:
327+
328+
>
329+
330+
Here's an empty list:
331+
332+
-
333+
334+
### Mixed Formatting
335+
336+
**Bold _and italic_ text** with `code` inside.
337+
338+
_Italic **and bold** text_ with ~~strikethrough~~.
339+
340+
`Code with **bold** and *italic*` (should not render formatting inside code).
341+
342+
### Long Content
343+
344+
This is a very long line of text that should wrap properly and demonstrate how the styling handles lengthy content without breaking the layout or causing horizontal scrolling issues in most cases.
345+
346+
| Very Long Header That Might Cause Issues | Another Long Header | Short |
347+
| ------------------------------------------------------------- | ------------------- | ----- |
348+
| Very long cell content that might wrap or cause layout issues | More content | OK |
349+
350+
---
351+
352+
## Test Summary
353+
354+
This document tests:
355+
356+
**Headers** (H1-H6)
357+
**Text formatting** (bold, italic, strikethrough, etc.)
358+
**Lists** (ordered, unordered, nested, tasks)
359+
**Links and images** (various styles)
360+
**Code blocks** (multiple languages)
361+
**Tables** (simple, aligned, complex)
362+
**Blockquotes** (simple, nested, with formatting)
363+
**Custom MDX components** (Alert, Callout, CodeBlock)
364+
**HTML elements** (emphasis, kbd, sup/sub, etc.)
365+
**Special characters and entities**
366+
**Edge cases and escape characters**
367+
368+
---
369+
370+
_End of formatting test document_

0 commit comments

Comments
 (0)