mirror of https://github.com/vuejs/vitepress
feat(theme): make prev/next links changeable (#1972)
Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>pull/1599/head
parent
58f455bdb4
commit
b8a5e8e5b2
@ -1,29 +1,43 @@
|
||||
# Prev Next Link
|
||||
|
||||
You can customize the text of previous and next links. This is helpful if you want to show different text on previous/next links than what you have on your sidebar.
|
||||
You can customize the text and link for the previous and next pages (shown at doc footer). This is helpful if you want a different text there than what you have on your sidebar. Additionally, you may find it useful to disable the footer or link to a page that is not included in your sidebar.
|
||||
|
||||
## prev
|
||||
|
||||
- Type: `string`
|
||||
- Type: `string | false | { text?: string; link?: string }`
|
||||
|
||||
- Details:
|
||||
|
||||
Specify the text to show on the link to the previous page.
|
||||
Specifies the text/link to show on the link to the previous page. If you don't set this in frontmatter, the text/link will be inferred from the sidebar config.
|
||||
|
||||
If you don't set this in frontmatter, the text will be inferred from the sidebar config.
|
||||
- Examples:
|
||||
|
||||
- Example:
|
||||
- To customize only the text:
|
||||
|
||||
```yaml
|
||||
---
|
||||
prev: 'Get Started | Markdown'
|
||||
---
|
||||
```
|
||||
```yaml
|
||||
---
|
||||
prev: 'Get Started | Markdown'
|
||||
---
|
||||
```
|
||||
|
||||
## next
|
||||
- To customize both text and link:
|
||||
|
||||
- Type: `string`
|
||||
```yaml
|
||||
---
|
||||
prev:
|
||||
text: 'Markdown'
|
||||
link: '/guide/markdown'
|
||||
---
|
||||
```
|
||||
|
||||
- Details:
|
||||
- To hide previous page:
|
||||
|
||||
```yaml
|
||||
---
|
||||
prev: false
|
||||
---
|
||||
```
|
||||
|
||||
## next
|
||||
|
||||
Same as `prev` but for the next page.
|
||||
Same as `prev` but for the next page.
|
||||
|
Loading…
Reference in new issue