UnoPayv1.0.0
  1. خانه
  2. مشارکت

پروژه

مشارکت

پروژه همان 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 تغییر کرد آن را اجرا کنید.

terminal bash
# 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 ریشه همین سایت است.

نحوه افزودن صفحه

  1. مسیر را به groups در فایل assets/data/site.js پروژه طراحی اضافه کنید. جایگاه نوار کناری، ترتیب خواندن، مسیر راهنما، قبلی/بعدی و سایت‌مپ همگی از آن مشتق می‌شوند، بنابراین یک مسیر نمی‌تواند در یکی باشد و در دیگری غایب باشد.
  2. یک <section class="page" data-route="…"> به index.html پروژه طراحی اضافه کنید با data-group، data-title-fa و data-desc-fa. پورت عنوان سند، توضیح متا و ایندکس جستجو را از این مقادیر می‌سازد.
  3. دستور npm run port را اجرا کنید. این اسکریپت برای هر بخش یک content/pages/*.json استخراج می‌کند، استایل‌ها و ماژول‌های داده را بازتولید کرده و ساختار را بررسی می‌کند — یک بخش نامعتبر به جای حذف خاموش، فرآیند را متوقف می‌کند.
  4. هر داده‌ای که صفحه رندر می‌کند از طریق یک mount انجام می‌شود: تگ <div data-mount="name"></div> را به بخش اضافه کرده و کامپوننت را در components/mounts.tsx ثبت کنید. npm run check در صورت ثبت نشدن خطا می‌دهد.
  5. دستور npm run build را اجرا کنید. فایل‌های sitemap.xml، robots.txt و ایندکس جستجو به طور خودکار از جدول مسیرها در out/ تولید می‌شوند.