General

Visibility Rules

The visibilityRules option is a list of glob patterns that determine when the <Backlinks> (e.g. the backlinks in the Starlight sidebar) will be shown. When using the plugin it its default configuration (with Starlight), the backlinks will also only be shown if the sidebar is visible.

Note

These rules apply to the slug of the page, not its file path.

["**/*"]

<PageBacklinks /> is shown on all pages.

• Directoryprivate

  • page // <PageBacklinks> is shown
• Directorypublic

  • page // <PageBacklinks> is shown
  • cool-stuff // <PageBacklinks> is shown

["!**/*", "**/*"]

<PageBacklinks /> is never shown because the first rule matches and rejects all pages.

• Directoryprivate

  • page // <PageBacklinks> is not shown
• Directorypublic

  • page // <PageBacklinks> is not shown
  • cool-stuff // <PageBacklinks> is not shown

["**/public/*"]

<PageBacklinks /> is only shown on pages containing the public directory in their slug.

• Directoryprivate

  • page // <PageBacklinks> is not shown
• Directorypublic

  • page // <PageBacklinks> is shown
  • cool-stuff // <PageBacklinks> is shown

["**/page"]

<PageBacklinks /> is only shown on pages ending on the page slug.

• Directoryprivate

  • page // <PageBacklinks> is shown
• Directorypublic

  • page // <PageBacklinks> is shown
  • cool-stuff // <PageBacklinks> is not shown

["/public/page"]

<PageBacklinks /> is shown only on the page with the exact slug /public/page.

• Directoryprivate

  • page // <PageBacklinks> is shown
• Directorypublic

  • page // <PageBacklinks> is shown
  • cool-stuff // <PageBacklinks> is not shown