Skip to main content

validate-theme-config-footer-style

Require static themeConfig.footer.style values to use supported Docusaurus footer styles.

Targeted pattern scopeโ€‹

This rule targets docusaurus.config.* files and inspects themeConfig.footer.style.

What this rule reportsโ€‹

This rule reports static footer style values that are invalid or use non-canonical casing/whitespace.

Why this rule existsโ€‹

Footer style values affect the public appearance of the site footer and should stay within Docusaurus' supported set.

โŒ Incorrectโ€‹

export default {
themeConfig: {
footer: { style: "Light" },
},
};
export default {
themeConfig: {
footer: { style: "primary" },
},
};

โœ… Correctโ€‹

export default {
themeConfig: {
footer: { style: "light" },
},
};
export default {
themeConfig: {
footer: { style: "dark" },
},
};

Behavior and migration notesโ€‹

This rule autofixes valid-but-noncanonical static strings such as "Light".

For invalid static values, it reports and provides suggestions to set the style to "light" or "dark".

When not to use itโ€‹

Do not use this rule if your project intentionally injects nonstandard footer style values through a later transform step.

Rule catalog ID: R081

Further readingโ€‹