useConfig

The useConfig hook returns data from your theme configuration and current page context.

Return Values

• banner: data about Banner
• chat: data about Chat Link
• darkMode: a boolean whether the theme is dark or not
• direction: a string that defines the current writing direction
• docsRepositoryBase: a link string to the documentation repository
• editLink: data about Edit Link
• feedback: data about Feedback Link
• footer: data about Footer
• gitTimestamp: a function that renders the Last Updated Date
• head: an equivalent to Next.js Head tag
• i18n: data about Internationalization
• logo: a React component for the website’s logo
• logoLink: a link for the logo component
• navbar: components related to Navbar
• navigation: options about Navigation
• themeSwitch: data about Theme Switch
• nextThemes: data about theme configuration (see pacocoursey/next-themes)
• notFound: data to display when the page is not found
• primaryHue: data about Theme Color
• primarySaturation: data about Theme Color
• project: data about Project Link
• search: data about Search
• sidebar: data about Sidebar
• toc: data about Table of Contents Sidebar
• title: title about current page
• frontMatter: parsed front matter data