Using ReferringPagesPlugin

The ReferringPagesPlugin displays a list of pages that link to the current page (backlinks). It helps you discover which pages reference the current page, creating a "what links here" feature useful for understanding page relationships and finding related content. See Plugins for a complete list of available plugins.

Syntax

[{ReferringPagesPlugin}] renders as:

Using UndefinedPagesPlugin

Parameters

All parameters are optional:

Parameter	Type	Default	Description
`page`	string	current page	Show references to this page instead
`max`	number	10	Maximum pages to display
`show`	string	`list`	Output mode: `list` or `count`
`before`	string	—	Text placed before each link
`after`	string	—	Text placed after each link

Examples

Count only

[This page is referenced by <span data-jspwiki-placeholder="d86894d9-7"></span> pages.] renders as:

This page is referenced by 1 pages.

Limited results

[{ReferringPagesPlugin max=3}] renders as:

Using UndefinedPagesPlugin

Bullet list format

[{ReferringPagesPlugin before='* ' after='\n'}] renders as:

Using UndefinedPagesPlugin

References to a specific page

[{ReferringPagesPlugin page='Plugins'}] renders as:

No pages currently refer to this page.

Output

List mode: Displays a <ul> list of clickable page links
Count mode: Returns just the number of referring pages
No references: Shows "No pages currently refer to this page"

See Using UndefinedPagesPlugin to find pages that are linked but not yet created, and Using IndexPlugin for an alphabetical page index.