Skip to content

Options

starlightPageHistory({
route: 'history',
limit: 0,
commitUrl: 'https://github.com/acme/docs/commit/{sha}',
exclude: ['changelog', 'reference/'],
});

Default: 'history'

The last segment of a history page URL: /guides/setup/history/. Pick another one if a page of yours is called history.

Default: 0 (every version)

How many versions a history page shows, newest first. The page then says how many older ones it leaves out. A page edited hundreds of times builds a large history page; a limit keeps it light.

Default: built from the origin remote

A link from each version to its commit, with {sha} where the commit hash goes. The default works for GitHub, GitLab, Gitea and Forgejo remotes. Use false for no links, for example when readers cannot open the repository.

Default: []

Pages with no history page and no link. A slug matches one page ('changelog'). A slug ending in / matches a folder ('reference/').