Docs shell
Every product's docs in one shell, drawn from the product's name, its tree of pages, its search index and a Markdown reader.
import { DocsShell, DocsArticle, DocsMarkdown and 5 more } from "@arcadia/ui/web/docs"⌘K inside it to search.TSX
Static pages
TSX
Examples
DocsShell
namerequired- string
- The product's name, as its bar says it: the trail's middle level, and the key its recent pages are kept under.
base- stringDefault "/docs"
- Where its pages live: the trail's last level, and the only paths drawn in place.
navrequired- DocsGroup[]
- Its tree of pages: the groups and their rows, in order.
indexrequired- DocsIndex
- Its search index: the address of its JSON, read on the first search, or the entries.
suggested- string[]
- The pages search offers before anything is typed; the tree's first four by default.
pathrequired- string
- The page drawn, its address's path.
navigate- (href: string) => void
- Draws a page of the docs in place (a router's push); without it, a link loads its page.
signedIn- booleanDefault false
- Members rows show only to a reader who is signed in, and on a members page itself.
hostsrequired- { arcadia: string; home?: string }
- Where the mark leads (Arcadia's home) and the product's name (its home,
/by default). pinnedTheme- "light" | "dark" | null
- A theme the link pins (
?theme=), previewed without touching the stored choice. pinnedMotion- "on" | null
- Reduced motion the link pins (
?rm=1), the same way.
slugrequired- string
pathrequired- string
markdownrequired- string
- The page's Markdown twin.
sectionrequired- string
titlerequired- string
descriptionrequired- string
bodyrequired- string
referencerequired- boolean
- A reference page: the rail lists h2 only.
relatedrequired- ArticleLink[]
prev- { href: string; title: string; description?: string }
next- { href: string; title: string; description?: string }
readerrequired- { Markdown: (props: DocsReaderProps) => ReactNode; plugins?: readonly unknown[] }
- Reads
body: the product's Markdown parser, drawing the kit's elements. With react-markdown and remark-gfm,{ Markdown, plugins: [remarkGfm] }. feedback- ReactNode
- The feedback line: the product's
PageFeedback, sending where it sends. None, no line. contact- string
- Where help and feedback go, an email address. None, no line.