Npm Factory
GitHub →

← Back to module

JSDoc

Functions

createDocsNavFromDot

function

Creates a simple navigation model from a DOT manifest. The site can map this structure into Fumadocs-compatible navigation.

createDocsNavFromDot(dot: DotLike): DocsNavItem[]

Callout

function
Callout(props: CalloutProps): import("/home/runner/work/npm-factory/npm-factory/node_modules/.pnpm/@types+react@19.2.10/node_modules/@types/react/jsx-runtime").JSX.Element

CodeGroup

function
CodeGroup(props: CodeGroupProps): import("/home/runner/work/npm-factory/npm-factory/node_modules/.pnpm/@types+react@19.2.10/node_modules/@types/react/jsx-runtime").JSX.Element

Step

function
Step(props: StepProps): import("/home/runner/work/npm-factory/npm-factory/node_modules/.pnpm/@types+react@19.2.10/node_modules/@types/react/jsx-runtime").JSX.Element

Steps

function
Steps(props: PropsWithChildren): import("/home/runner/work/npm-factory/npm-factory/node_modules/.pnpm/@types+react@19.2.10/node_modules/@types/react/jsx-runtime").JSX.Element

Tab

function
Tab(props: TabProps): import("/home/runner/work/npm-factory/npm-factory/node_modules/.pnpm/@types+react@19.2.10/node_modules/@types/react/jsx-runtime").JSX.Element

Tabs

function
Tabs(props: TabsProps): import("/home/runner/work/npm-factory/npm-factory/node_modules/.pnpm/@types+react@19.2.10/node_modules/@types/react/jsx-runtime").JSX.Element

Types

DocsNavItem

type
type DocsNavItem = {
  title: string;
  href: string;
  items: DocsNavItem[];
}

DotLike

type
type DotLike = {
  project: {
    id: string;
  };
  modules: DotLikeModule[];
  docs: {
    apiDocs: "enabled" | "disabled";
  };
}