Skip to content

Commit 4c512a1

Browse files
committed
Update markdown docs
1 parent 9ad7093 commit 4c512a1

File tree

1 file changed

+42
-22
lines changed

1 file changed

+42
-22
lines changed

nvim/.config/nvim/lua/docs/render_markdown_examples.md

Lines changed: 42 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,26 @@ This file demonstrates all features of the render-markdown.nvim plugin.
77
All heading levels are supported with custom icons:
88

99
# Heading 1
10+
1011
## Heading 2
12+
1113
### Heading 3
14+
1215
#### Heading 4
16+
1317
##### Heading 5
18+
1419
###### Heading 6
1520

1621
---
1722

1823
## Text Formatting
1924

20-
**Bold text** using double asterisks or __double underscores__.
25+
**Bold text** using double asterisks or **double underscores**.
2126

22-
*Italic text* using single asterisks or _single underscores_.
27+
_Italic text_ using single asterisks or _single underscores_.
2328

24-
***Bold and italic*** using triple asterisks.
29+
**_Bold and italic_** using triple asterisks.
2530

2631
~~Strikethrough~~ using double tildes.
2732

@@ -90,7 +95,7 @@ print(fibonacci(10))
9095
```javascript
9196
// JavaScript code example
9297
const factorial = (n) => {
93-
return n <= 1 ? 1 : n * factorial(n - 1);
98+
return n <= 1 ? 1 : n * factorial(n - 1);
9499
};
95100

96101
console.log(factorial(5));
@@ -113,7 +118,9 @@ ls -la
113118
> And have multiple paragraphs.
114119
115120
> Nested quotes work too:
121+
>
116122
> > This is nested inside
123+
> >
117124
> > > And this is even deeper
118125
119126
---
@@ -134,19 +141,19 @@ Auto-link: <https://example.com>
134141

135142
## Tables
136143

137-
| Feature | Status | Priority |
138-
|---------|--------|----------|
139-
| Headings | ✅ Done | High |
140-
| Code blocks | ✅ Done | High |
141-
| Tables | ✅ Done | Medium |
142-
| Callouts | 🔄 Testing | Medium |
144+
| Feature | Status | Priority |
145+
| ----------- | ---------- | -------- |
146+
| Headings | ✅ Done | High |
147+
| Code blocks | ✅ Done | High |
148+
| Tables | ✅ Done | Medium |
149+
| Callouts | 🔄 Testing | Medium |
143150

144151
### Aligned Tables
145152

146153
| Left aligned | Center aligned | Right aligned |
147-
|:-------------|:--------------:|--------------:|
148-
| Left | Center | Right |
149-
| Text | More text | Numbers: 123 |
154+
| :----------- | :------------: | ------------: |
155+
| Left | Center | Right |
156+
| Text | More text | Numbers: 123 |
150157

151158
---
152159

@@ -180,9 +187,9 @@ Three or more hyphens, asterisks, or underscores:
180187

181188
---
182189

183-
***
190+
---
184191

185-
___
192+
---
186193

187194
---
188195

@@ -198,6 +205,7 @@ ___
198205
> With multiple lines.
199206
200207
2. Second ordered item
208+
201209
```lua
202210
-- Code block in a list
203211
local x = 42
@@ -206,7 +214,7 @@ ___
206214
3. Third ordered item
207215
| Column A | Column B |
208216
|----------|----------|
209-
| Data 1 | Data 2 |
217+
| Data 1 | Data 2 |
210218

211219
---
212220

@@ -225,6 +233,7 @@ Here's a sentence with a footnote.[^1]
225233
Another sentence with another footnote.[^2]
226234

227235
[^1]: This is the first footnote.
236+
228237
[^2]: This is the second footnote with more details.
229238

230239
---
@@ -243,7 +252,8 @@ Term 2
243252
## LaTeX Math
244253

245254
**Note:** Requires either `latex2text` (pylatexenc) or `utftex` to be installed and in PATH. Try both to see which one you prefer.
246-
- We default to `utftex` since (1) it can be installed system-wide via Homebrew, instead of requiring pip, and (2) it looks better
255+
256+
- We choose `utftex` since (1) it can be installed system-wide via Homebrew, instead of requiring pip/conda, and (2) it looks better
247257

248258
### Inline Math
249259

@@ -258,21 +268,25 @@ Subscripts and superscripts: $x_1, x_2, x^2, x^{2n}$
258268
### Block Math
259269

260270
Quadratic formula:
271+
261272
$$
262273
x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}
263274
$$
264275

265276
Integral:
277+
266278
$$
267279
\int_0^\infty e^{-x^2} dx = \frac{\sqrt{\pi}}{2}
268280
$$
269281

270282
Summation:
283+
271284
$$
272285
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
273286
$$
274287

275288
Matrix:
289+
276290
$$
277291
\begin{pmatrix}
278292
a & b\\
@@ -281,26 +295,31 @@ c & d
281295
$$
282296

283297
Limits:
298+
284299
$$
285300
\lim_{x \to \infty} \frac{1}{x} = 0
286301
$$
287302

288303
Fractions and nested expressions:
304+
289305
$$
290306
\frac{d}{dx}\left(\frac{x^2 + 1}{x - 1}\right)
291307
$$
292308

293309
Set notation:
310+
294311
$$
295312
\mathbb{R}, \mathbb{N}, \mathbb{Z}, \mathbb{Q}, \mathbb{C}
296313
$$
297314

298315
Logical operators:
316+
299317
$$
300318
\forall x \in \mathbb{R}, \exists y \in \mathbb{R}: x < y
301319
$$
302320

303321
Calculus:
322+
304323
$$
305324
\nabla \cdot \mathbf{F} = \frac{\partial F_x}{\partial x} + \frac{\partial F_y}{\partial y} + \frac{\partial F_z}{\partial z}
306325
$$
@@ -315,6 +334,7 @@ $$
315334
> Complete these tasks before the deadline!
316335
317336
- [x] Set up development environment
337+
318338
```bash
319339
npm install
320340
npm run dev
@@ -326,11 +346,11 @@ $$
326346
- [ ] Error handling
327347

328348
- [ ] Write documentation
329-
| Section | Status |
330-
|---------|--------|
331-
| Setup | |
332-
| API | 🔄 |
333-
| Deploy | |
349+
| Section | Status |
350+
|---------|--------|
351+
| Setup | ✅ |
352+
| API | 🔄 |
353+
| Deploy | ❌ |
334354

335355
> [!TIP]
336356
> Use `git commit -m "message"` for atomic commits.

0 commit comments

Comments
 (0)