概述#
本文档是 Astro Theme Pure 主题的完整使用指南,涵盖了 Markdown 语法支持、MDX 使用方法以及主题相关的功能说明。
Markdown 语法支持#
Markdown 是一种轻量级且易于使用的语法,用于为您的写作设计风格。
基本语法#
标题#
文章内容较多时,可以用标题分段:
# 标题 1
## 标题 2
## 大标题
### 小标题markdown粗斜体#
_斜体文本_
**粗体文本**
**_粗斜体文本_** markdown预览:
斜体文本
粗体文本
粗斜体文本
链接#
文字链接 [链接名称](http://链接网址)markdown预览:
文字链接 链接名称 ↗
行内代码#
这是一条 `单行代码`markdown预览:
这是一条 行内代码
代码块#
```js
// calculate fibonacci
function fibonacci(n) {
if (n <= 1) return 1
return fibonacci(n - 1) + fibonacci(n - 2)
}
```markdown预览:
// calculate fibonacci
function fibonacci(n) {
if (n <= 1) return 1
return fibonacci(n - 1) + fibonacci(n - 2)
}js行内公式#
这是一条行内公式 $e^{i\pi} + 1 = 0$markdown预览:
在Markdown中,行内公式使用单个 $ 符号包裹,例如:
公式块#
$$
\hat{f}(\xi) = \int_{-\infty}^{\infty} f(x) e^{-2\pi i x \xi} \, dx
$$markdown预览:
公式块使用双 $$ 符号包裹:
图片#
markdown删除线#
~~删除线~~markdown预览:
删除线
列表#
普通无序列表
- 1
- 2
- 3markdown预览:
- 1
- 2
- 3
普通有序列表
1. GPT-4
2. Claude Opus
3. LLaMamarkdown预览:
- GPT-4
- Claude Opus
- LLaMa
列表里可以继续嵌套语法。
引用#
> 枪响,雷鸣,剑起。繁花血景。markdown预览:
枪响,雷鸣,剑起。繁花血景。
引用里也可以继续嵌套语法。
换行#
Markdown 分段落是需要空一行的。
如果不空行
就会在一段
第一段
第二段markdown预览:
如果不空行 就会在一段
第一段
第二段
分隔符#
如果你有写分割线的习惯,可以新起一行输入三个减号--- 或者星号 ***。当前后都有段落时,请空出一行:
---markdown预览:
高级技巧#
行内 HTML 元素#
目前只支持部分段内 HTML 元素效果,包括 <kbd> <b> <i> <em> <sup> <sub> <br>,如:
键位显示#
使用 <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>Del</kbd> 重启电脑markdown预览:
使用 Ctrl + Alt + Del 重启电脑
粗斜体#
<b> Markdown 在此处同样适用,如 _加粗_ </b>markdown预览:
Markdown 在此处同样适用,如 加粗折叠块#
<details><summary>点击展开</summary>它被隐藏了</details>markdown预览:
点击展开
它被隐藏了表格#
| 表头1 | 表头2 |
| ----- | ----- |
| 内容1 | 内容2 |markdown预览:
| 表头1 | 表头2 |
|---|---|
| 内容1 | 内容2 |
注释#
在引用的地方使用 [^注释] 来添加注释。
然后在文档的结尾,添加注释的内容(会默认于文章结尾渲染之)。
[^注释]: 这里是注释的内容markdown预览:
在引用的地方使用 1 来添加注释。
然后在文档的结尾,添加注释的内容(会默认于文章结尾渲染之)。
To-Do 列表#
- [ ] 未完成的任务
- [x] 已完成的任务markdown预览:
- 未完成的任务
- 已完成的任务
符号转义#
如果你的描述中需要用到 markdown 的符号,比如 _ # * 等,但又不想它被转义,这时候可以在这些符号前加反斜杠,如 \_ \# \* 进行避免。
\_不想这里的文本变斜体\_
\*\*不想这里的文本被加粗\*\*markdown预览:
_不想这里的文本变斜体_
**不想这里的文本被加粗**
使用 MDX#
什么是 MDX?#
MDX 是一种特殊的 Markdown 格式,支持嵌入 JavaScript 和 JSX 语法。这使得您可以在 Markdown 内容中混合 JavaScript 和 UI 组件 ↗,用于创建交互式图表或提示框等。
为什么使用 MDX?#
如果您已有使用 MDX 编写的内容,这个集成可以让您轻松迁移到 Astro。
使用示例#
以下是在 MDX 中导入和使用 UI 组件的方法。当您在浏览器中打开此页面时,应该能看到下面可点击的按钮。
import { Button } from 'astro-pure/user'
<Button>Click Me</Button>jsx组件使用#
在 MDX 文件中,您可以导入并使用 Astro Theme Pure 提供的各种组件:
import { Aside, Button, Card } from 'astro-pure/user'
<Aside type="tip">
这是一个提示框示例。
</Aside>
<Button href="/blog">查看文章</Button>jsx更多资源#
内嵌 Astro 组件#
Astro Theme Pure 支持在 Markdown/MDX 中使用各种组件。详细信息请参考:
总结#
Astro Theme Pure 提供了完整的 Markdown 和 MDX 支持,让您可以:
- 使用标准的 Markdown 语法编写内容
- 通过 MDX 嵌入交互式组件
- 使用主题提供的各种 UI 组件
- 支持数学公式、代码高亮等高级功能
开始使用这些功能,让您的内容更加丰富和交互式!
Footnotes#
-
这里是注释的内容 ↩