Intro

This page contains information pertaining the configuration of the backlinks component.

Compared to the graph component, the backlinks does not have as many configuration options (or more correctly: just 1). Regardless, the backlinks component can be ‘configured’ in one of three ways:

Via Plugin Settings

astro.config.mjs

import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import starlightSiteGraph from 'starlight-site-graph'
export default defineConfig({
  integrations: [
    starlight({
      plugins: [starlightSiteGraph({
        backlinksConfig: {
          // Global backlinks configuration
        }
      })],
    }),
  ],
})

Via Frontmatter

Note

This only applies to the <PageBacklinks/> component.

src/content/docs/my-page.md

---
title: My Page
 backlinks:
   visible: true
---

My page content goes here!

Via Component Props

src/content/docs/my-page.mdx

---
title: My Page
---

 import { Backlinks, PageBacklinks } from 'starlight-site-graph/components';

 This page contains two different graphs:
 <Backlinks sitemap={{...}} backlinks={[...]} />
 <PageBacklinks />

Sections

General Configuration Configure the general workings of the backlinks component.