Options

Pass options to pluginGitDiff().

rspress.config.ts

pluginGitDiff({
  maxCommits: 30,
  commitMessage: 'strip-refs',
  since: 'v1.0',
});

Option	Default	Description
`changesRoutePath`	`'/changes'`	URL of the recent changes page, after the version and language prefixes
`changesTitle`	per language	Title of the recent changes page, such as `{ en: 'What changed', ja: '変更履歴' }`
`changesInLlms`	`false`	List the recent changes pages in `llms.txt` when the site sets `llms`; see Recent changes
`maxCommits`	`50`	Number of commits on each recent changes page, counted separately for each version and language
`maxDiffLines`	`50`	Diffs with more changed lines than this are collapsed on the recent changes page. Added and removed lines count together, so a rewritten line counts as 2
`commitMessage`	`'strip-refs'`	How to show commit subjects; see below
`issueRefPattern`	`#123`, `group/project#45`, `!67`	References removed in the `strip-refs` mode; needs the `g` flag
`since`	none	Write only the history after this tag or commit, and only the tags that descend from it; see Large sites
`tagPattern`	none	Only tags that match can be used in `?diff=` and are written; see Large sites
`showAuthor`	`false`	Show the author name of each commit
`pageHistory`	`true`	The history of each page; `false` turns it off, and `{ entries }` chooses where its entries go: `'footer'`, `'nav'`, or none (default `['footer']`)
`maxPageRevisions`	`20`	Number of revisions listed in the history of a page

Commit messages

Commit messages may refer to an issue tracker that readers cannot see. commitMessage chooses what to publish.

'full': the subject line as it is.
'strip-refs': the subject line without issue and merge request references. Fix the timeout (#12) becomes Fix the timeout.
'none': no message; readers see the date and the diff.

Only the subject line, the first line of the message, is used. The body of a message is never published.

The interface of the plugin is available in English, Japanese and Chinese, and follows the language of the page. Other languages show English.