Extensions
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
permalinkas 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:
External Links
External links have target="_blank" rel="noreferrer":
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:
Superscripts and Subscripts
- Use
^ ^for superscript notation. - Use
~ ~for subscript notation.
Input:
- 19^th^
- H~2~OOutput:
- 19th
- H2O
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 3Output:
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].
From India.Rabindranath Tagore The Farthest Distance in the World ↩︎
