mirror of
https://github.com/hanzo-docs/docs.git
synced 2026-10-30 14:41:16 +00:00
zeekay
526c397db0
New package providing shared configuration, components, and presets for multi-organization documentation ecosystems (Hanzo, Lux, Zoo, Zen). Includes: - defineOrg/defineProject config helpers with type-safe schemas - ProjectSwitcher dropdown component for navbar - createOrgLayout factory eliminating per-project layout boilerplate - Org presets with project catalogs and brand colors
74 lines
2.6 KiB
TypeScript
74 lines
2.6 KiB
TypeScript
import type { ReactNode } from 'react';
|
|
import type { BaseLayoutProps, LinkItemType } from '@hanzo/docs-base-ui/layouts/shared';
|
|
import type { ProjectConfig } from './types';
|
|
import { resolveProjectUrl } from './config';
|
|
import { ProjectSwitcher } from './components/project-switcher';
|
|
|
|
interface OrgLayoutResult {
|
|
baseOptions: () => BaseLayoutProps;
|
|
linkItems: LinkItemType[];
|
|
logo: ReactNode;
|
|
createMetadata: (opts?: { title?: string; description?: string }) => {
|
|
title: string;
|
|
description: string;
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Create a fully configured layout from a project config.
|
|
* Returns baseOptions, linkItems, logo, and createMetadata — so each
|
|
* project app needs zero layout boilerplate.
|
|
*/
|
|
export function createOrgLayout(config: ProjectConfig): OrgLayoutResult {
|
|
const { org, project } = config;
|
|
|
|
const githubUrl = project.github ?? `${org.github}/${project.slug}`;
|
|
|
|
const linkItems: LinkItemType[] = [
|
|
{
|
|
text: 'Documentation',
|
|
url: '/docs',
|
|
active: 'nested-url',
|
|
},
|
|
{
|
|
type: 'icon',
|
|
url: githubUrl,
|
|
label: 'github',
|
|
text: 'GitHub',
|
|
icon: (
|
|
<svg role="img" viewBox="0 0 24 24" fill="currentColor">
|
|
<path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12" />
|
|
</svg>
|
|
),
|
|
external: true,
|
|
},
|
|
];
|
|
|
|
const logo = (
|
|
<span className="font-medium">{project.name}</span>
|
|
);
|
|
|
|
function baseOptions(): BaseLayoutProps {
|
|
return {
|
|
nav: {
|
|
title: (
|
|
<div className="flex items-center gap-2">
|
|
<ProjectSwitcher config={config} />
|
|
{logo}
|
|
</div>
|
|
),
|
|
},
|
|
links: linkItems,
|
|
};
|
|
}
|
|
|
|
function createMetadata(opts?: { title?: string; description?: string }) {
|
|
return {
|
|
title: opts?.title ?? `${project.name} Documentation`,
|
|
description: opts?.description ?? project.description,
|
|
};
|
|
}
|
|
|
|
return { baseOptions, linkItems, logo, createMetadata };
|
|
}
|