- خانه
- مشارکت
پروژه
مشارکت
پروژه همان SDK است. این سایت آن را مستند میکند، و راه صادق نگه داشتنش اسکریپتی است که این دو را با هم مقایسه میکند.
پکیج SDK
| ویژگی | مقدار |
|---|---|
| پکیج | unopay@1.0.0 |
| نصب | npm i unopay |
| فرمت ماژول | ESM با "type": "module"، بههمراه یک بیلد CJS از tsup |
| ابزارها | pnpm · tsup · vitest · tsc |
| زمان اجرا | بدون هیچ وابستگی زمان اجرا؛ فقط fetch استاندارد |
| مجوز | ISC طبق README. مخزن در کامیت 4a04be5 نه فایل LICENSE دارد و نه فیلد license در package.json. |
| منبع تأیید | هر امضا روی این سایت از src/ در کامیت 4a04be5 منتقل شده است |
همگام نگه داشتن این سایت
scripts/check-port.mjs فهرست اکسپورتها و ماتریس درگاههایی که این سایت مستند میکند را با درخت سورس SDK مقایسه میکند. هر بار که SDK تغییر کرد آن را اجرا کنید.
# the SDK checkout sits next to this repo
npm run check
# machine readable, for CI
npm run check -- --json
# non-zero exit on drift is the default; fail loudly in CI
دستورالعمل کامل، از جمله نحوه افزودن صفحه و اینکه محتوای هر بخش از کجا میآید، در فایل CONTRIBUTING.md ریشه همین سایت است.
نحوه افزودن صفحه
-
مسیر را به
groupsدر فایلassets/data/site.jsپروژه طراحی اضافه کنید. جایگاه نوار کناری، ترتیب خواندن، مسیر راهنما، قبلی/بعدی و سایتمپ همگی از آن مشتق میشوند، بنابراین یک مسیر نمیتواند در یکی باشد و در دیگری غایب باشد. -
یک
<section class="page" data-route="…">بهindex.htmlپروژه طراحی اضافه کنید باdata-group،data-title-faوdata-desc-fa. پورت عنوان سند، توضیح متا و ایندکس جستجو را از این مقادیر میسازد. -
دستور
npm run portرا اجرا کنید. این اسکریپت برای هر بخش یکcontent/pages/*.jsonاستخراج میکند، استایلها و ماژولهای داده را بازتولید کرده و ساختار را بررسی میکند — یک بخش نامعتبر به جای حذف خاموش، فرآیند را متوقف میکند. -
هر دادهای که صفحه رندر میکند از طریق یک mount انجام میشود: تگ
<div data-mount="name"></div>را به بخش اضافه کرده و کامپوننت را درcomponents/mounts.tsxثبت کنید.npm run checkدر صورت ثبت نشدن خطا میدهد. -
دستور
npm run buildرا اجرا کنید. فایلهایsitemap.xml،robots.txtو ایندکس جستجو به طور خودکار از جدول مسیرها درout/تولید میشوند.