Skip to content

Commit 01f5b0c

Browse files
committed
doc: add documentation
1 parent f19dc20 commit 01f5b0c

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

packages/docs/docs/theme/default-theme-config.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -409,17 +409,23 @@ module.exports = {
409409
docsBranch: 'master',
410410
// defaults to false, set to true to enable
411411
editLinks: true,
412+
// default value is true. Allows to hide next page links on all pages
413+
nextLinks: false,
414+
// default value is true. Allows to hide prev page links on all pages
415+
prevLinks: false,
412416
// custom text for edit link. Defaults to "Edit this page"
413417
editLinkText: 'Help us improve this page!'
414418
}
415419
}
416420
```
417421

418-
You can also hide the edit link on a specific page via `YAML front matter`:
422+
You can overwrite the following properties on specific pages via `YAML front matter`:
419423

420424
``` yaml
421425
---
422-
editLink: false
426+
editLink: false # Will overwrite 'editLinks' from themeConfig
427+
prev: true # Will overwrite 'prevLinks' property from themeConfig
428+
next: ./my-next-page # Will overwrite 'nextLinks' property from themeConfig
423429
---
424430
```
425431

0 commit comments

Comments
 (0)