Header Anchors

Headers automatically have anchors applied.

Custom Anchors

To specify a custom anchor for a header instead of using the auto-generated one, add a suffix to the header:

# Using a Custom Anchor {#my-anchor}

This allows linking to the header as #my-anchor instead of the default #using-a-custom-anchor.

Links

Internal and external links are specially processed.

The theme automatically generates a new link for each md file and stores it in the permalink of the corresponding md file's frontmatter. You can modify these links at any time. You can also disable this feature via the theme.autoFrontmatter option, reverting to VuePress's default behavior.

Internal Links

There are three ways to use internal links:

• Use the generated permalink as the target for the internal link.
• Use the relative path of the md file as the target for the internal link.
• Use the absolute path of the md file as the target for the internal link. The absolute path / indicates starting from the ${sourceDir} directory.

[Markdown](/guide/markdown/)

[Markdown](./basic.md)

Renders as:

Markdown

Markdown

External Links

External links have target="_blank" rel="noreferrer":

VuePress

GitHub-Style Tables

Input:

| Tables        |      Are      |  Cool |
| ------------- | :-----------: | ----: |
| col 3 is      | right-aligned | $1600 |
| col 2 is      |   centered    |   $12 |
| zebra stripes |   are neat    |    $1 |

Output:

Tables	Are	Cool
col 3 is	right-aligned	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

Table of Contents

Input:

[[TOC]]

Output:

• Header Anchors
  • Custom Anchors
• Links
  • Internal Links
  • External Links
• GitHub-Style Tables
• Table of Contents
• Superscripts and Subscripts
• Custom Alignment
• Task Lists
• Footnotes

Superscripts and Subscripts

• Use ^ ^ for superscript notation.
• Use ~ ~ for subscript notation.

Input:

- 19^th^
- H~2~O

Output:

• 19^th
• H₂O

Custom Alignment

Input:

::: left
Left-aligned content
:::

::: center
Centered content
:::

::: right
Right-aligned content
:::

Output:

Left-aligned content

Centered content

Right-aligned content

Task Lists

Input:

- [ ] Task 1
- [x] Task 2
- [ ] Task 3

Output:

• Task 1
• Task 2
• Task 3

Footnotes

Input:

The farthest distance in the world Is not the distance between life and death But you don't know I love you when I stand in front of you.[^footnote1]。

[^footnote1]: From India.Rabindranath Tagore **The Farthest Distance in the World**

Output:

The farthest distance in the world Is not the distance between life and death But you don't know I love you when I stand in front of you.^[1]。

---

1. From India.Rabindranath Tagore The Farthest Distance in the World ↩︎

Contributors

zhenghaoyang24pengzhanbo

Changelog

12/1/25, 3:30 AM

View All Changelog

• db8a4-docs: optimize and completion docs (#766)on 12/1/25
• 4d236-feat(theme)!: add collections support (#704)on 10/7/25
• 497fe-docs: fix markdown formatting and update snippet path in usage guideon 3/29/25
• 9f99a-docs: add en markdown doc (#538)on 3/27/25
• 0fd6c-refactor(theme): improve types and flat config (#524)on 3/15/25
• a4ac3-docs: add en-US docs (#514)on 3/9/25

Edit this page

Previous pageBasic

Next pageAttribute Support