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.

["**/*"]

<PageBacklinks /> is shown on all pages.

• Directorysrc

  • Directorycontent

    • Directorydocs

      • Directoryprivate

        • page.md // <PageBacklinks> is shown
      • Directorypublic

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

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

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

• Directorysrc

  • Directorycontent

    • Directorydocs

      • Directoryprivate

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

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

["**/public/*"]

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

• Directorysrc

  • Directorycontent

    • Directorydocs

      • Directoryprivate

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

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

["**/page.md"]

<PageBacklinks /> is only shown on pages with the name page.md.

• Directorysrc

  • Directorycontent

    • Directorydocs

      • Directoryprivate

        • page.md // <PageBacklinks> is shown
      • Directorypublic

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

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

<PageBacklinks /> is shown on all pages except for those in the public directory.

• Directorysrc

  • Directorycontent

    • Directorydocs

      • Directoryprivate

        • page.md // <PageBacklinks> is shown
      • Directorypublic

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