Theme components

<GuiderToc />#

React component that will show the currently configured table of contents.

It respects the configured toc in the layout settings. Read more about partials.

Will show one of:

  • Nothing if the table of contents is set to be hidden.
  • The default table of contents with the configured settings.
  • The custom component if the table of contents has been overriden in the partials.

Example#

<div id="custom-toc">
  <GuiderToc />
</div>

Reference#

function GuiderToc(): ReactNode;