mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-10-09 07:25:02 +03:00
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.
This commit is contained in:
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: مستندات 3x-ui
|
||||
description: مستندات رسمی 3x-ui — یک پنل وب پیشرفته برای مدیریت سرورهای Xray-core، پروکسیها، کلاینتها و سابسکریپشنها.
|
||||
icon: House
|
||||
---
|
||||
|
||||
**3x-ui** یک پنل وب متنباز برای استقرار و مدیریت سرورهای
|
||||
[Xray-core](https://github.com/XTLS/Xray-core) است. این پنل یک داشبورد مدرن برای
|
||||
اینباندها، پروتکلها، کلاینتها، حسابداری ترافیک، سابسکریپشنها و موارد دیگر در
|
||||
اختیار شما میگذارد — بدون نیاز به ویرایش دستی JSON مربوط به Xray از طریق خط فرمان.
|
||||
|
||||
این سایت، مستندات رسمی و مجموعهای از **ابزارهای تعاملی و درونمرورگری**
|
||||
(تولیدکنندههای پیکربندی) است که کاملاً روی دستگاه شما اجرا میشوند — هیچ دادهای
|
||||
هرگز از صفحه خارج نمیشود.
|
||||
|
||||
## از اینجا شروع کنید
|
||||
|
||||
<Cards>
|
||||
<Card
|
||||
title="3x-ui چیست؟"
|
||||
href="/docs/guide"
|
||||
description="نمای کلی: Xray-core، پنل، و اینکه برای چه کسانی مناسب است."
|
||||
/>
|
||||
<Card
|
||||
title="نصب"
|
||||
href="/docs/guide/installation"
|
||||
description="نصب از طریق اسکریپت، Docker یا بهصورت دستی."
|
||||
/>
|
||||
<Card
|
||||
title="نخستین ورود"
|
||||
href="/docs/guide/first-login"
|
||||
description="به پنل دسترسی پیدا کنید و پیش از هر کار دیگری آن را ایمنسازی کنید."
|
||||
/>
|
||||
<Card
|
||||
title="REALITY"
|
||||
href="/docs/config/reality"
|
||||
description="راهاندازی VLESS + REALITY همراه با XTLS-Vision."
|
||||
/>
|
||||
</Cards>
|
||||
|
||||
## ویژگیهای شاخص
|
||||
|
||||
- **همه پروتکلهای اصلی** — VLESS، VMess، Trojan، Shadowsocks، WireGuard،
|
||||
Hysteria2، SOCKS، HTTP و Dokodemo-door.
|
||||
- **REALITY و XTLS-Vision** — ترنسپورتهای مدرن و مقاوم در برابر سانسور.
|
||||
- **کنترلهای اختصاصی هر کلاینت** — سهمیه ترافیک، تاریخ انقضا، محدودیت IP، لینکهای
|
||||
اشتراکگذاری و کدهای QR.
|
||||
- **سابسکریپشنها** — قالبهای VLESS، Clash/Mihomo و JSON.
|
||||
- **عملیات** — مدیریت چندنودی، ربات Telegram، پشتیبانگیری و یک REST API.
|
||||
|
||||
<Callout type="info">
|
||||
با Xray تازه آشنا شدهاید؟ ابتدا [3x-ui چیست؟](/docs/guide) را بخوانید — توضیح میدهد که پنل، Xray-core و
|
||||
اپلیکیشنهای کلاینت شما چگونه در کنار هم کار میکنند.
|
||||
</Callout>
|
||||
Reference in New Issue
Block a user