Skip to main content

Docusaurus

Components​

The Docusaurus component family provides the following components:

DocusaurusDoc​

This component should be the top level of any Docusaurus content that's not a full page where you want access to context (typically account pages and so on). This sets up the various context providers before passing all props down to the InnerPageWrapper. This is required because the context providers need to be setup for the modal and loading state work we do in the InnerPageWrapper

You can import the DocusaurusDoc component from the docusaurus component family in the @freesewing/react package:

Javascript
import { DocusaurusDoc } from "@freesewing/react/components/Docusaurus"

DocusaurusPage​

This component should be the top level of a Docusaurus page where you want access to context. This sets up the various context providers before passing all props down to the InnerPageWrapper. This is required because the context providers need to be set up for the modal and loading state work. We also re-use the Docusaurus Layout component here, which needs to be at the top level of the page.

You can import the DocusaurusPage component from the docusaurus component family in the @freesewing/react package:

Javascript
import { DocusaurusPage } from "@freesewing/react/components/Docusaurus"

A component to render (some) custom navbar items in Docusaurus This can be used to swizzle the default NavbarItem in Docusaurus. You should pass it in the default NavbarItem and it will use that for all but the following: account, designs, docs, blog, showcase, forum

You can import the NavbarItem component from the docusaurus component family in the @freesewing/react package:

Javascript
import { NavbarItem } from "@freesewing/react/components/Docusaurus"