msb-public
/
vitepress
mirror of https://github.com/vuejs/vitepress
2
1
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'bf2ee7c8c3'
${ noResults }
vitepress/docs/en/reference/default-theme-prev-next-lin...

1.0 KiB
Raw Blame History

description
Customize the previous and next page links displayed at the bottom of doc pages in VitePress.

Prev Next Links

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 | false | { text?: string; link?: string }

  • Details:

    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.

  • Examples:

    • To customize only the text:

      ---
prev: 'Get Started | Markdown'
---

    • To customize both text and link:

      ---
prev:
  text: 'Markdown'
  link: '/guide/markdown'
---

    • To hide previous page:

      ---
prev: false
---

next

Same as prev but for the next page.