@jet-w/astro-blog 0.1.6 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/chunk-6D3XRDNY.js +145 -0
- package/dist/chunk-A2E2VSAQ.js +246 -0
- package/dist/{chunk-GYLSY3OJ.js → chunk-TJTPX2WP.js} +1 -1
- package/dist/config/index.d.ts +3 -47
- package/dist/config/index.js +18 -2
- package/dist/i18n-PgMCFBw0.d.ts +222 -0
- package/dist/index.d.ts +204 -7
- package/dist/index.js +255 -3
- package/dist/integration.d.ts +9 -1
- package/dist/integration.js +2 -1
- package/dist/{sidebar-DNdiCKBw.d.ts → sidebar-Da-W_4Lr.d.ts} +1 -1
- package/dist/utils/sidebar.d.ts +1 -1
- package/package.json +1 -1
- package/src/components/blog/FloatingToc.vue +11 -3
- package/src/components/blog/Hero.astro +17 -2
- package/src/components/blog/NavigationTabs.vue +46 -15
- package/src/components/blog/PostCard.astro +28 -10
- package/src/components/blog/RelatedPosts.astro +23 -7
- package/src/components/blog/TableOfContents.astro +10 -4
- package/src/components/blog/TagCloud.astro +4 -3
- package/src/components/home/FeaturedPostsSection.astro +22 -6
- package/src/components/home/QuickNavSection.astro +33 -4
- package/src/components/home/RecentPostsSection.astro +22 -6
- package/src/components/home/StatsSection.astro +24 -6
- package/src/components/layout/Footer.astro +36 -20
- package/src/components/layout/Header.astro +75 -17
- package/src/components/layout/Sidebar.astro +40 -25
- package/src/components/ui/LanguageSwitcher.vue +183 -0
- package/src/components/ui/SearchBox.vue +13 -5
- package/src/components/ui/SearchInterface.vue +49 -25
- package/src/layouts/BaseLayout.astro +77 -52
- package/src/layouts/PageLayout.astro +22 -27
- package/src/layouts/SlidesLayout.astro +14 -2
- package/src/pages/archives/[year]/[month].astro +36 -17
- package/src/pages/archives/index.astro +36 -20
- package/src/pages/categories/[category].astro +33 -16
- package/src/pages/categories/index.astro +37 -14
- package/src/pages/posts/[...slug].astro +125 -18
- package/src/pages/posts/index.astro +59 -37
- package/src/pages/posts/page/[page].astro +65 -27
- package/src/pages/rss.xml.ts +18 -6
- package/src/pages/search.astro +50 -14
- package/src/pages/slides/index.astro +25 -6
- package/src/pages/tags/[tag].astro +32 -15
- package/src/pages/tags/index.astro +39 -16
- package/src/plugins/remark-containers.mjs +351 -322
- package/src/plugins/remark-protect-code.mjs +69 -0
- package/src/styles/global.css +35 -1
- package/templates/default/.claude/ralph-loop.local.md +48 -0
- package/templates/default/astro.config.mjs +33 -4
- package/templates/default/content/posts/blog_docs_en/01.get-started/01-intro.md +81 -0
- package/templates/default/content/posts/blog_docs_en/01.get-started/02-install.md +137 -0
- package/templates/default/content/posts/blog_docs_en/01.get-started/03-create-post.md +176 -0
- package/templates/default/content/posts/blog_docs_en/01.get-started/04-structure.md +173 -0
- package/templates/default/content/posts/blog_docs_en/01.get-started/05-deploy.md +208 -0
- package/templates/default/content/posts/blog_docs_en/01.get-started/README.md +52 -0
- package/templates/default/content/posts/blog_docs_en/02.guide/02-containers.md +245 -0
- package/templates/default/content/posts/blog_docs_en/02.guide/03-code-blocks.md +207 -0
- package/templates/default/content/posts/blog_docs_en/02.guide/03-mermaid.md +194 -0
- package/templates/default/content/posts/blog_docs_en/02.guide/04-icons.md +229 -0
- package/templates/default/content/posts/blog_docs_en/02.guide/06-latex.md +233 -0
- package/templates/default/content/posts/blog_docs_en/02.guide/07-video.md +184 -0
- package/templates/default/content/posts/blog_docs_en/02.guide/08-slides.md +359 -0
- package/templates/default/content/posts/blog_docs_en/02.guide/README.md +213 -0
- package/templates/default/content/posts/blog_docs_en/03.config/01-site.md +208 -0
- package/templates/default/content/posts/blog_docs_en/03.config/02-sidebar.md +240 -0
- package/templates/default/content/posts/blog_docs_en/03.config/03-i18n.md +349 -0
- package/templates/default/content/posts/blog_docs_en/03.config/README.md +85 -0
- package/templates/default/content/posts/blog_docs_en/README.md +79 -0
- package/templates/default/content/posts/blog_docs_zh/01.get-started/01-intro.md +81 -0
- package/templates/default/content/posts/blog_docs_zh/01.get-started/02-install.md +137 -0
- package/templates/default/content/posts/blog_docs_zh/01.get-started/03-create-post.md +176 -0
- package/templates/default/content/posts/blog_docs_zh/01.get-started/04-structure.md +173 -0
- package/templates/default/content/posts/blog_docs_zh/01.get-started/05-deploy.md +208 -0
- package/templates/default/content/posts/blog_docs_zh/01.get-started/README.md +52 -0
- package/templates/default/content/posts/blog_docs_zh/02.guide/02-containers.md +245 -0
- package/templates/default/content/posts/blog_docs_zh/02.guide/03-code-blocks.md +206 -0
- package/templates/default/content/posts/blog_docs_zh/02.guide/03-mermaid.md +194 -0
- package/templates/default/content/posts/blog_docs_zh/02.guide/04-icons.md +229 -0
- package/templates/default/content/posts/blog_docs_zh/02.guide/06-latex.md +233 -0
- package/templates/default/content/posts/blog_docs_zh/02.guide/07-video.md +184 -0
- package/templates/default/content/posts/blog_docs_zh/02.guide/08-slides.md +359 -0
- package/templates/default/content/posts/blog_docs_zh/02.guide/README.md +213 -0
- package/templates/default/content/posts/blog_docs_zh/03.config/01-site.md +208 -0
- package/templates/default/content/posts/blog_docs_zh/03.config/02-sidebar.md +240 -0
- package/templates/default/content/posts/blog_docs_zh/03.config/03-i18n.md +348 -0
- package/templates/default/content/posts/blog_docs_zh/03.config/README.md +85 -0
- package/templates/default/content/posts/blog_docs_zh/README.md +78 -0
- package/templates/default/package-lock.json +9667 -0
- package/templates/default/package.json +1 -1
- package/templates/default/src/config/footer.ts +14 -11
- package/templates/default/src/config/locales/en/footer.ts +17 -0
- package/templates/default/src/config/locales/en/index.ts +20 -0
- package/templates/default/src/config/locales/en/menu.ts +14 -0
- package/templates/default/src/config/locales/en/sidebar.ts +34 -0
- package/templates/default/src/config/locales/en/site.ts +7 -0
- package/templates/default/src/config/locales/en/ui.ts +29 -0
- package/templates/default/src/config/locales/index.ts +7 -0
- package/templates/default/src/config/locales/zh-CN/footer.ts +17 -0
- package/templates/default/src/config/locales/zh-CN/index.ts +20 -0
- package/templates/default/src/config/locales/zh-CN/menu.ts +14 -0
- package/templates/default/src/config/locales/zh-CN/sidebar.ts +34 -0
- package/templates/default/src/config/locales/zh-CN/site.ts +7 -0
- package/templates/default/src/config/locales/zh-CN/ui.ts +29 -0
- package/templates/default/src/config/sidebar.ts +10 -12
- package/templates/default/src/config/site.ts +2 -2
- package/templates/default/src/content.config.ts +15 -3
- package/templates/default/src/env.d.ts +7 -0
- package/dist/chunk-MQXPSOYB.js +0 -124
- package/templates/default/content/posts/blog_docs/01-quick-start.md +0 -162
- package/templates/default/content/posts/blog_docs/02-frontmatter.md +0 -277
- package/templates/default/content/posts/blog_docs/03-markdown-basic.md +0 -350
- package/templates/default/content/posts/blog_docs/04-containers.md +0 -331
- package/templates/default/content/posts/blog_docs/05-code-blocks.md +0 -388
- package/templates/default/content/posts/blog_docs/06-mermaid.md +0 -431
- package/templates/default/content/posts/blog_docs/07-video.md +0 -243
- package/templates/default/content/posts/blog_docs/08-latex.md +0 -382
- package/templates/default/content/posts/blog_docs/09-icons.md +0 -326
- package/templates/default/content/posts/blog_docs/10-sidebar.md +0 -445
- package/templates/default/content/posts/blog_docs/11-config.md +0 -334
- package/templates/default/content/posts/blog_docs/12-slides.mdx +0 -552
- package/templates/default/content/posts/blog_docs/README.md +0 -151
|
@@ -0,0 +1,359 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Slides (Presentations)
|
|
3
|
+
description: Create interactive presentations with Reveal.js
|
|
4
|
+
pubDate: 2025-01-01
|
|
5
|
+
author: jet-w
|
|
6
|
+
categories:
|
|
7
|
+
- Documentation
|
|
8
|
+
tags:
|
|
9
|
+
- Slides
|
|
10
|
+
- Reveal.js
|
|
11
|
+
- Presentations
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# Slides (Presentations)
|
|
15
|
+
|
|
16
|
+
This blog integrates [Reveal.js](https://revealjs.com/) to let you create beautiful interactive presentations using Markdown.
|
|
17
|
+
|
|
18
|
+
## Quick Start
|
|
19
|
+
|
|
20
|
+
### Creating a Presentation
|
|
21
|
+
|
|
22
|
+
Create a Markdown file in the `content/slides/` directory:
|
|
23
|
+
|
|
24
|
+
```markdown
|
|
25
|
+
---
|
|
26
|
+
title: My Presentation
|
|
27
|
+
description: A demo presentation
|
|
28
|
+
pubDate: 2025-01-01
|
|
29
|
+
theme: black
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
# First Slide
|
|
33
|
+
|
|
34
|
+
This is the opening
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Second Slide
|
|
39
|
+
|
|
40
|
+
- Point one
|
|
41
|
+
- Point two
|
|
42
|
+
- Point three
|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
# Thank You!
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Slide Separators
|
|
50
|
+
|
|
51
|
+
- Use `---` (three dashes) to separate **horizontal slides**
|
|
52
|
+
- Use `----` (four dashes) to separate **vertical slides**
|
|
53
|
+
|
|
54
|
+
```markdown
|
|
55
|
+
# Topic One
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
# Topic Two
|
|
60
|
+
|
|
61
|
+
This is horizontal navigation
|
|
62
|
+
|
|
63
|
+
----
|
|
64
|
+
|
|
65
|
+
## Topic Two Details
|
|
66
|
+
|
|
67
|
+
This is a vertical sub-slide (press ↓)
|
|
68
|
+
|
|
69
|
+
----
|
|
70
|
+
|
|
71
|
+
## More Details
|
|
72
|
+
|
|
73
|
+
Continue vertical navigation
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
# Topic Three
|
|
78
|
+
|
|
79
|
+
Back to horizontal navigation
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Frontmatter Configuration
|
|
83
|
+
|
|
84
|
+
| Option | Type | Default | Description |
|
|
85
|
+
|:---|:---|:---|:---|
|
|
86
|
+
| `title` | string | - | Presentation title (required) |
|
|
87
|
+
| `description` | string | - | Presentation description |
|
|
88
|
+
| `pubDate` | Date | - | Publication date |
|
|
89
|
+
| `author` | string | - | Author |
|
|
90
|
+
| `tags` | string[] | [] | Tags |
|
|
91
|
+
| `theme` | string | "black" | Theme name |
|
|
92
|
+
| `transition` | string | "slide" | Transition animation |
|
|
93
|
+
| `controls` | boolean | true | Show control arrows |
|
|
94
|
+
| `progress` | boolean | true | Show progress bar |
|
|
95
|
+
| `slideNumber` | boolean | false | Show slide numbers |
|
|
96
|
+
| `draft` | boolean | false | Draft status |
|
|
97
|
+
|
|
98
|
+
### Available Themes
|
|
99
|
+
|
|
100
|
+
| Theme | Description |
|
|
101
|
+
|:---|:---|
|
|
102
|
+
| `black` | Black background, white text (default) |
|
|
103
|
+
| `white` | White background, black text |
|
|
104
|
+
| `league` | Gray background |
|
|
105
|
+
| `beige` | Beige background, vintage style |
|
|
106
|
+
| `night` | Night mode, dark blue background |
|
|
107
|
+
| `serif` | Serif fonts, academic style |
|
|
108
|
+
| `simple` | Minimalist white |
|
|
109
|
+
| `solarized` | Solarized color scheme |
|
|
110
|
+
|
|
111
|
+
### Transitions
|
|
112
|
+
|
|
113
|
+
| Transition | Description |
|
|
114
|
+
|:---|:---|
|
|
115
|
+
| `none` | No animation |
|
|
116
|
+
| `fade` | Fade in/out |
|
|
117
|
+
| `slide` | Slide (default) |
|
|
118
|
+
| `convex` | Convex effect |
|
|
119
|
+
| `concave` | Concave effect |
|
|
120
|
+
| `zoom` | Zoom effect |
|
|
121
|
+
|
|
122
|
+
## Writing Content
|
|
123
|
+
|
|
124
|
+
### Titles and Text
|
|
125
|
+
|
|
126
|
+
```markdown
|
|
127
|
+
# Main Title
|
|
128
|
+
|
|
129
|
+
## Section Title
|
|
130
|
+
|
|
131
|
+
Regular paragraph text
|
|
132
|
+
|
|
133
|
+
**Bold** and *italic*
|
|
134
|
+
|
|
135
|
+
> Blockquote
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Lists
|
|
139
|
+
|
|
140
|
+
```markdown
|
|
141
|
+
## Unordered List
|
|
142
|
+
|
|
143
|
+
- Item one
|
|
144
|
+
- Item two
|
|
145
|
+
- Item three
|
|
146
|
+
|
|
147
|
+
---
|
|
148
|
+
|
|
149
|
+
## Ordered List
|
|
150
|
+
|
|
151
|
+
1. First step
|
|
152
|
+
2. Second step
|
|
153
|
+
3. Third step
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Code Highlighting
|
|
157
|
+
|
|
158
|
+
````markdown
|
|
159
|
+
## Code Example
|
|
160
|
+
|
|
161
|
+
```javascript
|
|
162
|
+
function hello(name) {
|
|
163
|
+
console.log(`Hello, ${name}!`);
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
hello('World');
|
|
167
|
+
```
|
|
168
|
+
````
|
|
169
|
+
|
|
170
|
+
Supports syntax highlighting for all common programming languages.
|
|
171
|
+
|
|
172
|
+
### Math Formulas
|
|
173
|
+
|
|
174
|
+
LaTeX math formulas are supported:
|
|
175
|
+
|
|
176
|
+
```markdown
|
|
177
|
+
## Math Formulas
|
|
178
|
+
|
|
179
|
+
Inline: $E = mc^2$
|
|
180
|
+
|
|
181
|
+
Block:
|
|
182
|
+
|
|
183
|
+
$$
|
|
184
|
+
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
|
|
185
|
+
$$
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
### Mermaid Diagrams
|
|
189
|
+
|
|
190
|
+
````markdown
|
|
191
|
+
## Flowchart
|
|
192
|
+
|
|
193
|
+
```mermaid
|
|
194
|
+
graph TD
|
|
195
|
+
A[Start] --> B{Condition}
|
|
196
|
+
B -->|Yes| C[Execute]
|
|
197
|
+
B -->|No| D[Skip]
|
|
198
|
+
C --> E[End]
|
|
199
|
+
D --> E
|
|
200
|
+
```
|
|
201
|
+
````
|
|
202
|
+
|
|
203
|
+
### Column Layout
|
|
204
|
+
|
|
205
|
+
```html
|
|
206
|
+
## Two Columns
|
|
207
|
+
|
|
208
|
+
<div style="display: flex; gap: 2rem;">
|
|
209
|
+
<div style="flex: 1;">
|
|
210
|
+
|
|
211
|
+
### Left Side
|
|
212
|
+
|
|
213
|
+
- Content one
|
|
214
|
+
- Content two
|
|
215
|
+
|
|
216
|
+
</div>
|
|
217
|
+
<div style="flex: 1;">
|
|
218
|
+
|
|
219
|
+
### Right Side
|
|
220
|
+
|
|
221
|
+
- Content three
|
|
222
|
+
- Content four
|
|
223
|
+
|
|
224
|
+
</div>
|
|
225
|
+
</div>
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### Images
|
|
229
|
+
|
|
230
|
+
```markdown
|
|
231
|
+
## Image Display
|
|
232
|
+
|
|
233
|
+

|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
### Tables
|
|
237
|
+
|
|
238
|
+
```markdown
|
|
239
|
+
## Comparison
|
|
240
|
+
|
|
241
|
+
| Feature | Option A | Option B |
|
|
242
|
+
|:---|:---:|:---:|
|
|
243
|
+
| Performance | High | Medium |
|
|
244
|
+
| Usability | Medium | High |
|
|
245
|
+
| Cost | Low | Medium |
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
## Fragment Animations
|
|
249
|
+
|
|
250
|
+
Use HTML attributes to add step-by-step reveal effects:
|
|
251
|
+
|
|
252
|
+
```html
|
|
253
|
+
## Step by Step
|
|
254
|
+
|
|
255
|
+
<ul>
|
|
256
|
+
<li class="fragment">Step one</li>
|
|
257
|
+
<li class="fragment">Step two</li>
|
|
258
|
+
<li class="fragment">Step three</li>
|
|
259
|
+
</ul>
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
### Fragment Types
|
|
263
|
+
|
|
264
|
+
```html
|
|
265
|
+
<p class="fragment fade-in">Fade in</p>
|
|
266
|
+
<p class="fragment fade-out">Fade out</p>
|
|
267
|
+
<p class="fragment highlight-red">Highlight red</p>
|
|
268
|
+
<p class="fragment highlight-blue">Highlight blue</p>
|
|
269
|
+
<p class="fragment grow">Grow</p>
|
|
270
|
+
<p class="fragment shrink">Shrink</p>
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
## Keyboard Shortcuts
|
|
274
|
+
|
|
275
|
+
Available shortcuts in presentation mode:
|
|
276
|
+
|
|
277
|
+
| Shortcut | Function |
|
|
278
|
+
|:---|:---|
|
|
279
|
+
| `→` / `←` | Horizontal navigation |
|
|
280
|
+
| `↓` / `↑` | Vertical navigation |
|
|
281
|
+
| `Space` | Next slide |
|
|
282
|
+
| `Esc` | Overview mode |
|
|
283
|
+
| `F` | Fullscreen mode |
|
|
284
|
+
| `S` | Speaker view |
|
|
285
|
+
| `B` | Black screen pause |
|
|
286
|
+
| `?` | Show help |
|
|
287
|
+
|
|
288
|
+
## Speaker View
|
|
289
|
+
|
|
290
|
+
Press `S` to open speaker view, which shows:
|
|
291
|
+
|
|
292
|
+
- Current slide
|
|
293
|
+
- Next slide preview
|
|
294
|
+
- Speaker notes
|
|
295
|
+
- Timer
|
|
296
|
+
|
|
297
|
+
### Adding Speaker Notes
|
|
298
|
+
|
|
299
|
+
```markdown
|
|
300
|
+
## Slide Title
|
|
301
|
+
|
|
302
|
+
Slide content
|
|
303
|
+
|
|
304
|
+
Note:
|
|
305
|
+
These are speaker notes that the audience won't see.
|
|
306
|
+
You can write prompts, key points, etc.
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
## File Organization
|
|
310
|
+
|
|
311
|
+
Recommended directory structure:
|
|
312
|
+
|
|
313
|
+
```
|
|
314
|
+
content/
|
|
315
|
+
└── slides/
|
|
316
|
+
├── my-presentation.md # Single presentation
|
|
317
|
+
└── workshop/ # Series
|
|
318
|
+
├── 01-intro.md
|
|
319
|
+
├── 02-basics.md
|
|
320
|
+
└── 03-advanced.md
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
## Best Practices
|
|
324
|
+
|
|
325
|
+
::: tip Keep It Simple
|
|
326
|
+
Focus on one key point per slide. Avoid information overload.
|
|
327
|
+
:::
|
|
328
|
+
|
|
329
|
+
::: tip Visual Hierarchy
|
|
330
|
+
- Use headings to establish structure
|
|
331
|
+
- Use lists and diagrams effectively
|
|
332
|
+
- Leave appropriate whitespace
|
|
333
|
+
:::
|
|
334
|
+
|
|
335
|
+
::: tip Code Presentation
|
|
336
|
+
- Keep code snippets short
|
|
337
|
+
- Highlight key parts
|
|
338
|
+
- Add explanatory text
|
|
339
|
+
:::
|
|
340
|
+
|
|
341
|
+
::: warning Performance
|
|
342
|
+
- Optimize and compress images
|
|
343
|
+
- Avoid extremely long presentations
|
|
344
|
+
- Complex diagrams may need loading time
|
|
345
|
+
:::
|
|
346
|
+
|
|
347
|
+
## Example Presentations
|
|
348
|
+
|
|
349
|
+
Visit the `/slides` page to browse example presentations, including:
|
|
350
|
+
|
|
351
|
+
- Basic syntax demo
|
|
352
|
+
- Code highlighting examples
|
|
353
|
+
- Math formula showcase
|
|
354
|
+
- Mermaid diagrams
|
|
355
|
+
- Theme previews
|
|
356
|
+
|
|
357
|
+
---
|
|
358
|
+
|
|
359
|
+
Next: Check out [Icons](./04-icons) for visual elements.
|
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Writing Guide
|
|
3
|
+
description: Master content creation with Markdown, components, and advanced features
|
|
4
|
+
pubDate: 2025-01-01
|
|
5
|
+
author: jet-w
|
|
6
|
+
categories:
|
|
7
|
+
- Documentation
|
|
8
|
+
tags:
|
|
9
|
+
- Guide
|
|
10
|
+
- Markdown
|
|
11
|
+
- Writing
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
# Writing Guide
|
|
15
|
+
|
|
16
|
+
Learn how to create beautiful, engaging content for your blog.
|
|
17
|
+
|
|
18
|
+
## Content Guide
|
|
19
|
+
|
|
20
|
+
| Guide | Description |
|
|
21
|
+
|-------|-------------|
|
|
22
|
+
| [Containers](./02-containers) | Tips, warnings, and callout boxes |
|
|
23
|
+
| [Code Blocks](./03-code-blocks) | Syntax highlighting and features |
|
|
24
|
+
| [Mermaid Diagrams](./03-mermaid) | Flowcharts, sequences, and more |
|
|
25
|
+
| [Icons](./04-icons) | Use icons from multiple libraries |
|
|
26
|
+
| [LaTeX Math](./06-latex) | Mathematical formulas |
|
|
27
|
+
| [Video Embedding](./07-video) | YouTube, Bilibili, custom videos |
|
|
28
|
+
| [Slides](./08-slides) | Interactive presentations with Reveal.js |
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
# Markdown Essentials
|
|
33
|
+
|
|
34
|
+
Markdown is a lightweight markup language that makes writing formatted content easy and intuitive.
|
|
35
|
+
|
|
36
|
+
## Headings
|
|
37
|
+
|
|
38
|
+
Use `#` symbols for headings:
|
|
39
|
+
|
|
40
|
+
```markdown
|
|
41
|
+
# Heading 1
|
|
42
|
+
## Heading 2
|
|
43
|
+
### Heading 3
|
|
44
|
+
#### Heading 4
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
::: tip Best Practices
|
|
48
|
+
- Use only one `# Heading 1` per page (your title)
|
|
49
|
+
- Don't skip levels (don't jump from `##` to `####`)
|
|
50
|
+
- Keep headings concise
|
|
51
|
+
:::
|
|
52
|
+
|
|
53
|
+
## Text Formatting
|
|
54
|
+
|
|
55
|
+
### Basic Styles
|
|
56
|
+
|
|
57
|
+
| Syntax | Result | Use For |
|
|
58
|
+
|--------|--------|---------|
|
|
59
|
+
| `**bold**` | **bold** | Important terms |
|
|
60
|
+
| `*italic*` | *italic* | Emphasis |
|
|
61
|
+
| `~~strike~~` | ~~strike~~ | Deprecated content |
|
|
62
|
+
| `` `code` `` | `code` | Inline code |
|
|
63
|
+
|
|
64
|
+
### Combined Styles
|
|
65
|
+
|
|
66
|
+
```markdown
|
|
67
|
+
***bold and italic***
|
|
68
|
+
**bold with `code` inside**
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Links
|
|
72
|
+
|
|
73
|
+
### Basic Links
|
|
74
|
+
|
|
75
|
+
```markdown
|
|
76
|
+
[Link Text](https://example.com)
|
|
77
|
+
[Link with Title](https://example.com "Hover text")
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Internal Links
|
|
81
|
+
|
|
82
|
+
Link to other posts:
|
|
83
|
+
|
|
84
|
+
```markdown
|
|
85
|
+
[See the guide](./02-containers)
|
|
86
|
+
[Back to home](/)
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Images
|
|
90
|
+
|
|
91
|
+
### Basic Image
|
|
92
|
+
|
|
93
|
+
```markdown
|
|
94
|
+

|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Image with Caption
|
|
98
|
+
|
|
99
|
+
```markdown
|
|
100
|
+

|
|
101
|
+
*A beautiful sunset over the ocean*
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Image Sizing
|
|
105
|
+
|
|
106
|
+
Use HTML for more control:
|
|
107
|
+
|
|
108
|
+
```html
|
|
109
|
+
<img src="/images/photo.jpg" alt="Photo" width="300" />
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Lists
|
|
113
|
+
|
|
114
|
+
### Unordered Lists
|
|
115
|
+
|
|
116
|
+
```markdown
|
|
117
|
+
- Item one
|
|
118
|
+
- Item two
|
|
119
|
+
- Nested item
|
|
120
|
+
- Another nested
|
|
121
|
+
- Item three
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Result:
|
|
125
|
+
- Item one
|
|
126
|
+
- Item two
|
|
127
|
+
- Nested item
|
|
128
|
+
- Another nested
|
|
129
|
+
- Item three
|
|
130
|
+
|
|
131
|
+
### Ordered Lists
|
|
132
|
+
|
|
133
|
+
```markdown
|
|
134
|
+
1. First step
|
|
135
|
+
2. Second step
|
|
136
|
+
3. Third step
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Task Lists
|
|
140
|
+
|
|
141
|
+
```markdown
|
|
142
|
+
- [x] Completed task
|
|
143
|
+
- [ ] Pending task
|
|
144
|
+
- [ ] Another task
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
- [x] Completed task
|
|
148
|
+
- [ ] Pending task
|
|
149
|
+
- [ ] Another task
|
|
150
|
+
|
|
151
|
+
## Blockquotes
|
|
152
|
+
|
|
153
|
+
```markdown
|
|
154
|
+
> This is a quote.
|
|
155
|
+
> It can span multiple lines.
|
|
156
|
+
|
|
157
|
+
> Nested quotes:
|
|
158
|
+
>> Are also possible
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
> This is a quote.
|
|
162
|
+
> It can span multiple lines.
|
|
163
|
+
|
|
164
|
+
## Horizontal Rules
|
|
165
|
+
|
|
166
|
+
Create dividers with:
|
|
167
|
+
|
|
168
|
+
```markdown
|
|
169
|
+
---
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## Tables
|
|
175
|
+
|
|
176
|
+
```markdown
|
|
177
|
+
| Column 1 | Column 2 | Column 3 |
|
|
178
|
+
|----------|----------|----------|
|
|
179
|
+
| Cell 1 | Cell 2 | Cell 3 |
|
|
180
|
+
| Cell 4 | Cell 5 | Cell 6 |
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
| Column 1 | Column 2 | Column 3 |
|
|
184
|
+
|----------|----------|----------|
|
|
185
|
+
| Cell 1 | Cell 2 | Cell 3 |
|
|
186
|
+
| Cell 4 | Cell 5 | Cell 6 |
|
|
187
|
+
|
|
188
|
+
### Table Alignment
|
|
189
|
+
|
|
190
|
+
```markdown
|
|
191
|
+
| Left | Center | Right |
|
|
192
|
+
|:-----|:------:|------:|
|
|
193
|
+
| L | C | R |
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
| Left | Center | Right |
|
|
197
|
+
|:-----|:------:|------:|
|
|
198
|
+
| L | C | R |
|
|
199
|
+
|
|
200
|
+
## Escaping Characters
|
|
201
|
+
|
|
202
|
+
Use backslash to show literal characters:
|
|
203
|
+
|
|
204
|
+
```markdown
|
|
205
|
+
\*not italic\*
|
|
206
|
+
\# not a heading
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
\*not italic\*
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
Next: Learn about [Containers](./02-containers) for callouts and tips.
|