useConfig
⚠️
The useConfig
hook is made to dynamically configure your project. See
Theme Configuration for more
information about each customizable feature.
The useConfig
hook returns data from your theme configuration and current page
context.
Return Values
banner
: data about Bannerchat
: data about Chat LinkdarkMode
: a boolean whether the theme is dark or notdirection
: a string that defines the current writing directiondocsRepositoryBase
: a link string to the documentation repositoryeditLink
: data about Edit Linkfeedback
: data about Feedback Linkfooter
: data about FootergitTimestamp
: a function that renders the Last Updated Datehead
: an equivalent to Next.js Head tag (opens in a new tab)i18n
: data about Internationalizationlogo
: a React component for the website's logologoLink
: a link for thelogo
componentnavbar
: components related to Navbarnavigation
: options about NavigationthemeSwitch
: data about Theme SwitchnextThemes
: data about theme configuration (see pacocoursey/next-themes (opens in a new tab))notFound
: data to display when the page is not foundprimaryHue
: data about Theme ColorprimarySaturation
: data about Theme Colorproject
: data about Project Linksearch
: data about SearchserverSideError
: data to display when a server-side error happens (requires500.mdx
page too)sidebar
: data about Sidebartoc
: data about Table of Contents SidebaruseNextSeoOptions
: a function that passes data to Next.js SEO component. (see SEO Options)flexsearch
: data about search configurationtitle
: Title about current documentfrontMatter
: parsed front matter (opens in a new tab) data