Files
3x-ui/docs/components/mdx.tsx
T
MHSanaei 9b91f0f42e docs: vendor the documentation site into the monorepo
Fold the standalone 3x-ui-docs project (Next.js 16 + Fumadocs, deployed to
docs.sanaei.dev) into docs/ so the panel and its documentation share a single
source of truth, the way sing-box keeps its docs in-tree. The old repo becomes
redundant and can be retired.

- Import the full site under docs/ (app, components, content, lib, public,
  scripts, config). The self-contained pnpm project sits alongside the existing
  engineering notes with no filename collisions.
- Re-point "Edit on GitHub" links from MHSanaei/3x-ui-docs to this repo's
  docs/content/docs path (docs/lib/shared.ts, docs/app/.../page.tsx).
- Add docs-ci.yml and docs-deploy.yml under .github/workflows/, scoped to
  docs/** and run with working-directory: docs, since GitHub only runs
  workflows from the repo-root .github/. deploy-static.yml's GitHub Pages
  publish (CNAME docs.sanaei.dev) carries over unchanged.

Follow-up (outside this commit): attach the docs.sanaei.dev custom domain to
this repository's Pages (or set the Vercel project's root directory to docs),
confirm the site is live from the monorepo, then delete MHSanaei/3x-ui-docs.
2026-07-07 23:07:14 +02:00

48 lines
1.8 KiB
TypeScript

import defaultMdxComponents from 'fumadocs-ui/mdx';
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
import { Step, Steps } from 'fumadocs-ui/components/steps';
import { Mermaid } from '@/components/mdx/mermaid';
import { RealityConfigGenerator } from '@/components/tools/reality-config-generator';
import { ShareLinkInspector } from '@/components/tools/share-link-inspector';
import { InstallCommandBuilder } from '@/components/tools/install-command-builder';
import { ReverseProxyGenerator } from '@/components/tools/reverse-proxy-generator';
import { ProtocolWizard } from '@/components/tools/protocol-wizard';
import { FirewallRulesGenerator } from '@/components/tools/firewall-rules-generator';
import { OutboundGenerator } from '@/components/tools/outbound-generator';
import { RoutingBuilder } from '@/components/tools/routing-builder';
import { SubscriptionBuilder } from '@/components/tools/subscription-builder';
import { TelegramSetupHelper } from '@/components/tools/telegram-setup-helper';
import { ApiRequestBuilder } from '@/components/tools/api-request-builder';
import { OpenAPIPage } from '@/components/openapi-page';
import type { MDXComponents } from 'mdx/types';
export function getMDXComponents(components?: MDXComponents) {
return {
...defaultMdxComponents,
Tab,
Tabs,
Step,
Steps,
Mermaid,
RealityConfigGenerator,
ShareLinkInspector,
InstallCommandBuilder,
ReverseProxyGenerator,
ProtocolWizard,
FirewallRulesGenerator,
OutboundGenerator,
RoutingBuilder,
SubscriptionBuilder,
TelegramSetupHelper,
ApiRequestBuilder,
OpenAPIPage,
...components,
} satisfies MDXComponents;
}
export const useMDXComponents = getMDXComponents;
declare global {
type MDXProvidedComponents = ReturnType<typeof getMDXComponents>;
}