mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-08 21:56:08 +00:00
9b91f0f42e
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.
31 lines
874 B
TypeScript
31 lines
874 B
TypeScript
import { defineConfig, defineDocs } from 'fumadocs-mdx/config';
|
|
import { metaSchema, pageSchema } from 'fumadocs-core/source/schema';
|
|
import { z } from 'zod';
|
|
|
|
// `title` is already required by `pageSchema`. We additionally require a
|
|
// non-empty `description` on every page (used for SEO, search, and OG images),
|
|
// so the build fails fast if a page is missing it.
|
|
// See https://fumadocs.dev/docs/mdx/collections
|
|
export const docs = defineDocs({
|
|
dir: 'content/docs',
|
|
docs: {
|
|
schema: pageSchema.extend({
|
|
description: z
|
|
.string({ message: 'Every doc page needs a frontmatter `description`.' })
|
|
.min(1, 'Frontmatter `description` cannot be empty.'),
|
|
}),
|
|
postprocess: {
|
|
includeProcessedMarkdown: true,
|
|
},
|
|
},
|
|
meta: {
|
|
schema: metaSchema,
|
|
},
|
|
});
|
|
|
|
export default defineConfig({
|
|
mdxOptions: {
|
|
// MDX options
|
|
},
|
|
});
|