[react] feat: Added docs for components/Docusaurus
This commit is contained in:
parent
a5f4dfa6a3
commit
f6f6419cae
4 changed files with 99 additions and 10 deletions
|
@ -0,0 +1,29 @@
|
|||
import React from 'react'
|
||||
import { Popout } from '@freesewing/react/components/Popout'
|
||||
import ComponentTypes from '@theme-original/NavbarItem/ComponentTypes'
|
||||
import { NavbarItem as FreeSewingNavbarItem } from '@freesewing/react/components/Docusaurus'
|
||||
import Link from '@docusaurus/Link'
|
||||
|
||||
export const DocusaurusPageExample = () => (
|
||||
<Popout note>
|
||||
<h4>This is not an example</h4>
|
||||
<p>We cannot safely include this example in a page. But <a href="https://freesewing.org/signin/">the sign in page</a> is an example where this component is used.</p>
|
||||
<p>Essentially, use this if you want to use the components from <code>@freesewing/react</code> inside Docusaurus, and you do not want the standard <em>docs</em> layout (no sidebar).
|
||||
</p>
|
||||
</Popout>
|
||||
)
|
||||
|
||||
export const DocusaurusDocExample = () => (
|
||||
<Popout type="note">
|
||||
</Popout>
|
||||
)
|
||||
|
||||
const NavbarItem = ComponentTypes.default
|
||||
export const NavbarItemExample = () => (
|
||||
|
||||
<>
|
||||
<NavbarItem id="test" label="Default NavbarItem" href="#" />
|
||||
<FreeSewingNavbarItem id="account" Default={NavbarItem} label="Custom NavbarItem (account)" href="#" Link={Link} />
|
||||
</>
|
||||
)
|
||||
|
|
@ -2,6 +2,34 @@
|
|||
title: Docusaurus
|
||||
---
|
||||
|
||||
:::note
|
||||
This page is yet to be created
|
||||
:::
|
||||
import { DocusaurusDoc } from '@freesewing/react/components/Docusaurus'
|
||||
import { ComponentDocs } from '@site/src/components/component-docs.js'
|
||||
import {
|
||||
jsdocDocusaurusDoc,
|
||||
jsdocDocusaurusPage,
|
||||
jsdocNavbarItem,
|
||||
} from '@site/prebuild/jsdoc/components.docusaurus.mjs'
|
||||
import {
|
||||
DocusaurusDocExample,
|
||||
DocusaurusPageExample,
|
||||
NavbarItemExample,
|
||||
} from './_examples.js'
|
||||
|
||||
<DocusaurusDoc>
|
||||
|
||||
The **Docusaurus** component family provides the following components:
|
||||
|
||||
- [DocusaurusDoc](#docusaurusdoc)
|
||||
- [DocusaurusPage](#docusauruspage)
|
||||
- [NavbarItem](#navbaritem)
|
||||
|
||||
## DocusaurusDoc
|
||||
<ComponentDocs docs={jsdocDocusaurusDoc} example={DocusaurusDocExample} />
|
||||
|
||||
## DocusaurusPage
|
||||
<ComponentDocs docs={jsdocDocusaurusPage} example={DocusaurusPageExample} />
|
||||
|
||||
## NavbarItem
|
||||
<ComponentDocs docs={jsdocNavbarItem} example={NavbarItemExample} />
|
||||
|
||||
</DocusaurusDoc>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue