chore: rename docs-v2 to docs

This commit is contained in:
Rotimi Best
2025-12-21 12:37:06 +00:00
parent 2526f4c227
commit cc04fba42e
91 changed files with 1694 additions and 0 deletions
+112
View File
@@ -0,0 +1,112 @@
import { useMemo } from 'react';
import defaultMdxComponents from 'fumadocs-ui/mdx';
import { DocsLayout } from 'fumadocs-ui/layouts/docs';
import { createServerFn } from '@tanstack/react-start';
import type * as PageTree from 'fumadocs-core/page-tree';
import browserCollections from 'fumadocs-mdx:collections/browser';
import { createFileRoute, notFound } from '@tanstack/react-router';
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from 'fumadocs-ui/layouts/docs/page';
import { source } from '@/lib/source';
import { baseOptions } from '@/lib/layout.shared';
import { HomeLayout } from 'fumadocs-ui/layouts/home';
export const Route = createFileRoute('/$')({
component: Page,
loader: async ({ params }) => {
const slugs = params._splat?.split('/') ?? [];
const data = await loader({ data: slugs });
await clientLoader.preload(data.path);
return data;
}
});
const loader = createServerFn({
method: 'GET'
})
.inputValidator((slugs: string[]) => slugs)
.handler(async ({ data: slugs }) => {
const page = source.getPage(slugs);
if (!page) throw notFound();
return {
tree: source.pageTree as object,
path: page.path
};
});
const clientLoader = browserCollections.docs.createClientLoader({
component({ toc, frontmatter, default: MDX }) {
return (
<DocsPage toc={toc}>
<DocsTitle>{frontmatter.title}</DocsTitle>
<DocsDescription>{frontmatter.description}</DocsDescription>
<DocsBody>
<MDX
components={{
...defaultMdxComponents
}}
/>
</DocsBody>
</DocsPage>
);
}
});
function Page() {
const data = Route.useLoaderData();
const Content = clientLoader.getComponent(data.path);
const tree = useMemo(() => transformPageTree(data.tree as PageTree.Folder), [data.tree]);
return (
<HomeLayout {...baseOptions()}>
<DocsLayout
sidebar={{
collapsible: false
}}
themeSwitch={{
enabled: false
}}
searchToggle={{
enabled: false
}}
tree={tree}
>
<Content />
</DocsLayout>
</HomeLayout>
);
}
function transformPageTree(root: PageTree.Root): PageTree.Root {
function mapNode<T extends PageTree.Node>(item: T): T {
if (typeof item.icon === 'string') {
item = {
...item,
icon: (
<span
dangerouslySetInnerHTML={{
__html: item.icon
}}
/>
)
};
}
if (item.type === 'folder') {
return {
...item,
index: item.index ? mapNode(item.index) : undefined,
children: item.children.map(mapNode)
};
}
return item;
}
return {
...root,
children: root.children.map(mapNode),
fallback: root.fallback ? transformPageTree(root.fallback) : undefined
};
}
+118
View File
@@ -0,0 +1,118 @@
import * as React from 'react';
import { HeadContent, Outlet, Scripts, createRootRoute } from '@tanstack/react-router';
import { RootProvider } from 'fumadocs-ui/provider/tanstack';
import appCss from '@/styles/app.css?url';
export const Route = createRootRoute({
head: () => ({
meta: [
{
charSet: 'utf-8'
},
{
name: 'viewport',
content: 'width=device-width, initial-scale=1'
},
{
title: 'ClassroomIO | The Open Source Learning Management System for Companies'
},
{
name: 'description',
content:
'A flexible, user-friendly platform for creating, managing, and delivering courses for companies and training organisations'
},
{
property: 'og:url',
content: 'https://classroomio.com/docs'
},
{
property: 'og:type',
content: 'website'
},
{
property: 'og:title',
content: 'ClassroomIO | The Open Source Learning Management System for Companies'
},
{
property: 'og:description',
content:
'A flexible, user-friendly platform for creating, managing, and delivering courses for companies and training organisations'
},
{
property: 'og:image:type',
content: 'image/png'
},
{
property: 'og:image:width',
content: '1920'
},
{
property: 'og:image:height',
content: '1080'
},
{
property: 'og:image:secure_url',
itemProp: 'image',
content: 'https://brand.cdn.clsrio.com/og/classroomio-og.png'
},
{
name: 'twitter:card',
content: 'summary_large_image'
},
{
property: 'twitter:domain',
content: 'classroomio.com'
},
{
property: 'twitter:url',
content: 'https://classroomio.com/docs'
},
{
name: 'twitter:title',
content: 'ClassroomIO | The Open Source Learning Management System for Companies'
},
{
name: 'twitter:description',
content:
'A flexible, user-friendly platform for creating, managing, and delivering courses for companies and training organisations'
},
{
name: 'twitter:creator',
content: '@classroomio'
},
{
name: 'twitter:image',
content: 'https://brand.cdn.clsrio.com/og/classroomio-og.png'
}
],
links: [
{ rel: 'stylesheet', href: appCss },
{ rel: 'icon', href: '/docs/favicon.ico' }
]
}),
component: RootComponent
});
function RootComponent() {
return (
<RootDocument>
<Outlet />
</RootDocument>
);
}
function RootDocument({ children }: { children: React.ReactNode }) {
return (
<html suppressHydrationWarning>
<head>
<HeadContent />
</head>
<body className="flex min-h-screen flex-col">
<RootProvider>{children}</RootProvider>
<Scripts />
</body>
</html>
);
}
+16
View File
@@ -0,0 +1,16 @@
import { createFileRoute } from '@tanstack/react-router';
import { source } from '@/lib/source';
import { createFromSource } from 'fumadocs-core/search/server';
const server = createFromSource(source, {
// https://docs.orama.com/docs/orama-js/supported-languages
language: 'english',
});
export const Route = createFileRoute('/api/search')({
server: {
handlers: {
GET: async ({ request }) => server.GET(request),
},
},
});
+12
View File
@@ -0,0 +1,12 @@
import { createFileRoute, redirect } from '@tanstack/react-router';
export const Route = createFileRoute('/')({
beforeLoad: () => {
throw redirect({
to: '/$',
params: {
_splat: 'home'
}
});
}
});