Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation page for prev-next links #889

Merged
merged 3 commits into from
Jul 1, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 51 additions & 1 deletion docs/guide/theme-prev-next-link.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,53 @@
# Prev Next Link

Documentation coming soon...
Prev or Next Link allows you to add buttons at the end of each page that allow you to go to the previous or next topic. To enable it, add themeConfig.prev or themeConfig.next to your configuration.
otabekoff marked this conversation as resolved.
Show resolved Hide resolved


### prev

- Type: `NavLink | string`

- Details:

Specify the link of the previous page.

If you don't set this frontmatter, the link will be inferred from the sidebar config.

To configure the prev link manually, you can set this frontmatter to a `NavLink` object or a string:

- A `NavLink` object should have a `text` field and a `link` field.
- A string should be the path to the target page file. It will be converted to a `NavLink` object, whose `text` is the page title, and `link` is the page route path.

- Example:

```md
---
# NavLink
prev:
text: Get Started
link: /guide/getting-started.html

# NavLink - external url
prev:
text: GitHub
link: https://github.com

# string - page file path
prev: /guide/getting-started.md

# string - page file relative path
prev: ../../guide/getting-started.md
---
```

### next

- Type: `NavLink | string`

- Details:

Specify the link of the next page.

If you don't set this frontmatter, the link will be inferred from the sidebar config.

The type is the same as [prev](#prev) frontmatter.