Skip to content

Commit bd29c1b

Browse files
author
Simon Prickett
authored
Added documentation for how to suppress next/prev/edit this page links
Details on how to do this changed recently so I thought it was about time to document these options here for the first time as I didn't add this when I first introduced them!
1 parent 73cd474 commit bd29c1b

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,16 @@ authors: [suze,simon]
103103

104104
* Note that multiple authors are supported as shown above.
105105

106+
## Suppressing Next/Previous and Edit this Page Controls
107+
108+
By default, each page has navigation at the bottom for the next and previous pages, as well as an "Edit this page" link. If you want to suppress all or some of these, add the following extra front matter to your page's `.mdx` file:
109+
110+
```yaml
111+
custom_edit_url: null
112+
pagination_next: null
113+
pagination_prev: null
114+
```
115+
106116
## How to modify the homepage banner
107117
108118
In order to modify the homepage banner, you will need to edit the ```docusaurus.config.js``` file placed under the root of the repository.

0 commit comments

Comments
 (0)