mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-07-09 06:06:08 +00:00
MHSanaei
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.
73 lines
4.1 KiB
Plaintext
73 lines
4.1 KiB
Plaintext
---
|
|
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 />
|
|
</>
|
|
);
|
|
} |