Skip to content
Starlight Site Graph

General

This page discusses how you can manually set the sitemap, and how the sitemap is structured.

Sitemap

By default, the sitemap is generated by parsing both the Markdown files, and when building the website, the HTML files in the output directory.

If the sitemap option is set, it will be used instead of the generated sitemap.

The sitemap should be structured as follows:

  • key: The path of the page, must either be an absolute path or an external URL.
    • title: The title of the page in the graph.
    • exists: Whether the page exists or not (also known as an unresolved node).
    • external: Whether the page is an external link.
    • links: An array of paths to pages that this page links to.
    • backlinks: An array of paths to pages that link to this page.
    • tags: An array of tags associated with the page.
    • nodeStyle: The style of the node in the graph, overrides any other styles applied to the node. For more information on how to style nodes, check out the styling documentation.
Example
{
  "sitemap": {
    "node/": {
      "links": [
        "custom-node/",
        "external/"
      ],
      "tags": [
        "Tag"
      ],
      "title": "Node",
      "exists": true,
      "backlinks": []
    },
    "custom-node/": {
      "nodeStyle": {
        "shapeColor": "nodeColor3"
      },
      "title": "Custom Node",
      "exists": true,
      "links": [],
      "backlinks": [
        "node/"
      ]
    },
    "external/": {
      "external": true,
      "title": "External",
      "exists": true,
      "links": [],
      "backlinks": [
        "node/"
      ]
    }
  }
}
{}