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-09-04 01:17:15 +00:00 · 2026-07-07 23:07:14 +02:00
parent 2c49dbf54e
commit 9b91f0f42e
283 changed files with 44179 additions and 0 deletions
@@ -0,0 +1,73 @@
+---
+title: Сервер подписок
+description: >-
+  Отдельный HTTP/HTTPS-сервер, который отдаёт клиентам ссылки на подписки
+  прокси (стандартные, JSON и Clash). Сервер слушает на собственном порту (по
+  умолчанию 10882) и настраивается в разделе Settings → Subscription. Пути
+  настраиваемы; значения по умолчанию показаны ниже. Все конечные точки подписок
+  устанавливают заголовки ответа, по которым клиентские приложения считывают
+  информацию о трафике и сроке действия.
+full: true
+_openapi:
+  preload:
+    - ./public/openapi.json
+  toc:
+    - depth: 2
+      title: >-
+        Return base64-encoded subscription links for all enabled clients
+        matching the subscription ID. When the request has an Accept: text/html
+        header or ?html=1, renders a styled info page instead. Default path:
+        /sub/:subid.
+      url: >-
+        #return-base64-encoded-subscription-links-for-all-enabled-clients-matching-the-subscription-id-when-the-request-has-an-accept-texthtml-header-or-html1-renders-a-styled-info-page-instead-default-path-subsubid
+    - depth: 2
+      title: >-
+        Return subscription as a JSON array of proxy configs (one per enabled
+        client). Only when JSON subscription is enabled in settings. Default
+        path: /json/:subid.
+      url: >-
+        #return-subscription-as-a-json-array-of-proxy-configs-one-per-enabled-client-only-when-json-subscription-is-enabled-in-settings-default-path-jsonsubid
+    - depth: 2
+      title: >-
+        Return subscription as a Clash/Mihomo-compatible YAML config, including
+        configured global Clash routing rules. Only when Clash subscription is
+        enabled in settings. Default path: /clash/:subid.
+      url: >-
+        #return-subscription-as-a-clashmihomo-compatible-yaml-config-including-configured-global-clash-routing-rules-only-when-clash-subscription-is-enabled-in-settings-default-path-clashsubid
+  structuredData:
+    headings:
+      - content: >-
+          Return base64-encoded subscription links for all enabled clients
+          matching the subscription ID. When the request has an Accept:
+          text/html header or ?html=1, renders a styled info page instead.
+          Default path: /sub/:subid.
+        id: >-
+          return-base64-encoded-subscription-links-for-all-enabled-clients-matching-the-subscription-id-when-the-request-has-an-accept-texthtml-header-or-html1-renders-a-styled-info-page-instead-default-path-subsubid
+      - content: >-
+          Return subscription as a JSON array of proxy configs (one per enabled
+          client). Only when JSON subscription is enabled in settings. Default
+          path: /json/:subid.
+        id: >-
+          return-subscription-as-a-json-array-of-proxy-configs-one-per-enabled-client-only-when-json-subscription-is-enabled-in-settings-default-path-jsonsubid
+      - content: >-
+          Return subscription as a Clash/Mihomo-compatible YAML config,
+          including configured global Clash routing rules. Only when Clash
+          subscription is enabled in settings. Default path: /clash/:subid.
+        id: >-
+          return-subscription-as-a-clashmihomo-compatible-yaml-config-including-configured-global-clash-routing-rules-only-when-clash-subscription-is-enabled-in-settings-default-path-clashsubid
+    contents: []
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+export default function Layout(props) {
+  const { APIPage, OpenAPIPage } = props.components ?? {};
+  // "APIPage" is the old name from v10, this allows both for backward compatibility
+  const Comp = OpenAPIPage ?? APIPage;
+  return (
+    <>
+      {props.children}
+      <Comp document="./public/openapi.json" webhooks={[]} operations={[{"path":"/{subPath}{subid}","method":"get"},{"path":"/{jsonPath}{subid}","method":"get"},{"path":"/{clashPath}{subid}","method":"get"}]} showTitle />
+    </>
+  );
+}