Using UndefinedPagesPlugin

The UndefinedPagesPlugin lists all pages that are linked to on other pages (RED-LINKs) but have not yet been created.

Description

Whenever a page link points to a page that does not exist it becomes a RED-LINK — a red coloured link that takes you to the page creation editor. The UndefinedPagesPlugin scans the entire link graph and collects every such missing page in one place, making it easy to identify content gaps and prioritise which pages to create. See Plugins for a complete list of available plugins.

Syntax

[{UndefinedPagesPlugin}] renders as:

Parameters

All parameters are optional:

Parameter	Type	Default	Description
`max`	integer	unlimited	Maximum number of results to show
`format`	string	`list`	Output format: `list`, `count`, or `table`
`before`	string	—	Text/markup placed before each item (list format)
`after`	string	—	Text/markup placed after each item (list format)
`include`	regex	—	Only show undefined pages whose title matches this pattern
`exclude`	regex	—	Hide undefined pages whose title matches this pattern
`showReferring`	boolean	`false`	Expand each entry to show the pages that link to it

Examples

Count of undefined pages

[{UndefinedPagesPlugin format='count'}] renders as:

104

Top 10 list

[{UndefinedPagesPlugin max='10'}] renders as:

Table view

[{UndefinedPagesPlugin format='table' max='10'}] renders as:

Undefined Page	Referenced By
../config/app-default-config.json	1
../CONTRIBUTING.md#frontmatter-structure	1
../docs/managers/ValidationManager-Documentation.md	1
./docs/managers/ValidationManager-Documentation.md	1
./Page-Storage.md	1
#types	1
0-9	1
5m	1
a-f0-9-	1
A-M	1

The Referenced By column shows how many pages currently contain a link to each undefined page.

Show which pages reference each undefined page

[{UndefinedPagesPlugin showReferring='true' max='5'}] renders as:

Each undefined page is shown as a red create-link with a nested list of the existing pages that link to it — useful for auditing where red links come from so you can either create the missing page or fix the links.

Filter by title pattern

[{UndefinedPagesPlugin include='^Project.*' format='count'}] renders as:

Output Formats

Format	Description
`list`	Bulleted list of red create-links (default)
`count`	Plain number — total undefined pages on the platform
`table`	Table showing page name and how many pages link to it

Add showReferring='true' to any list or table result to expand the referring page information. count is unaffected.

See Using ReferringPagesPlugin to show pages that link to the current page, Using IndexPlugin for an alphabetical page index, and Plugins for the full list of available plugins.

Using UndefinedPagesPlugin (Documentation)

GeoHazardWatch