扩展
约 866 字大约 3 分钟
指南markdown
2024-03-05
标题锚点
标题会自动应用锚点。
自定义锚点
要为标题指定自定义锚点而不是使用自动生成的锚点,请向标题添加后缀:
# 使用自定义锚点 {#my-anchor}这允许将标题链接为 #my-anchor,而不是默认的 #使用自定义锚点。
链接
内部和外部链接都会被特殊处理。
主题默认对每个 Markdown 文件自动生成一个新的链接,并保存在对应的 Markdown 文件的 frontmatter 的 permalink(永久链接,用于指定页面的 URL 路径)中。您可以随时修改它们。您也可以通过 theme.autoFrontmatter 选项来禁用这个功能,这时会恢复为 VuePress 的默认行为。
内部链接
有三种方式来使用内部链接:
- 使用生成的
permalink作为内部链接的目标。 - 使用 Markdown 文件的相对路径作为内部链接的目标。
- 使用 Markdown 文件的绝对路径作为内部链接的目标,绝对路径
/表示从${sourceDir}目录开始。
[Markdown](/guide/markdown/)
[Markdown](./basic.md)渲染为:
外部链接
外部链接带有 target="_blank" rel="noreferrer" :
Github风格的表格
输入:
| Tables | Are | Cool |
| ------------- | :-----------: | ----: |
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |输出:
| Tables | Are | Cool |
|---|---|---|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
目录表
输入:
[[TOC]]输出:
上标 (Sup)
上标用于将文字显示在正常文字的上方,常用于数学公式中的指数表示(如 X²)、序数表示(如 19th)等场景。使用 ^ ^ 包裹的内容会被渲染为上标。
语法
X^2^
19^th^效果
X2
19th
下标 (Sub)
下标用于将文字显示在正常文字的下方,常用于化学公式(如 H₂O)、数学变量(如 a₁)等场景。使用 ~ ~ 包裹的内容会被渲染为下标。
语法
H~2~O效果
H2O
自定义对齐
输入:
::: left
左对齐的内容
:::
::: center
居中的内容
:::
::: right
右对齐的内容
:::输出:
左对齐的内容
居中的内容
右对齐的内容
任务列表 (Tasklist)
任务列表用于创建带有复选框的列表项,适用于展示待办事项、任务进度或检查清单。使用 - [ ] 表示未完成的任务,使用 - [x] 表示已完成的任务。
语法
- [ ] 任务 1
- [x] 任务 2
- [ ] 任务 3效果
脚注 (Footnote)
脚注用于在文档底部添加补充说明,而不影响正文的阅读流畅性。通过在正文中添加脚注标记([^标识]),并在文档任意位置定义脚注内容,读者可点击标记跳转查看对应的补充说明。脚注标识可以是数字或任意具有描述性的文本。
语法
这是一段文字[^1],需要添加脚注说明。
[^1]: 这是脚注的内容。也支持使用具描述性的标识:
人生自古谁无死,留取丹心照汗青[^脚注1]。
[^脚注1]: 出自 宋·文天祥 **《过零丁洋》**效果
这是一段文字[1],需要添加脚注说明。
人生自古谁无死,留取丹心照汗青[2]。
贡献者
更新日志
0daf2-docs: improve docs (#929)于97a5b-docs: fix typo于db8a4-docs: optimize and completion docs (#766)于4d236-feat(theme)!: add collections support (#704)于0fd6c-refactor(theme): improve types and flat config (#524)于b153b-docs: update docs于e3b1c-docs: improve docs于62e12-feat(theme): 新增<Card>卡片组件于824a5-Update 扩展.md to fix missing[!TIP]syntax in output于4349a-docs: update doc于
