فهرست مستندات پروژه
نصب از سورس
نسخه فعلی منتشرنشده را بسازید و همراه وابستگی‌های موتور مورد نیاز نصب کنید.
در تاریخ 2026-10-08، رجیستری عمومی npm برای دستور npm view fa-search-kit version --json خطای E404 برگرداند. نسخه ثبت‌شده در این سورس 0.1.0 است. روی در دسترس بودن npm install fa-search-kit حساب نکنید؛ فایل بسته را محلی بسازید و نصب کنید.
ساخت بسته
به Node.js نسخه 22 یا جدیدتر و npm نیاز دارید. ابزارهای توسعه فایل TypeScript را مستقیم اجرا می‌کنند؛ اعتبارسنجی این مستندات با Node.js 24.8.0 انجام شده است. اگر یکی از نسخه‌های اولیه Node 22 این ابزارها را اجرا نمی‌کند، از نسخه بهروز Node 22 یا Node 24 استفاده کنید. بسته ساخته‌شده از نوع ESM است و تعریف‌های TypeScript را هم دارد.
git clone https://github.com/eramhq/fa-search-kit.git
cd fa-search-kit
npm ci
npm run build
npm packدستور npm run build پوشه dist/ را می‌سازد. پیش از بستهبندی آن را اجرا کنید؛ ساخت خودکار پیش از npm pack تعریف نشده است. سپس در پوشه برنامه خود، فایل ساخته‌شده و موتور مورد نیاز را نصب کنید:
npm install /absolute/path/to/fa-search-kit/fa-search-kit-0.1.0.tgz
npm install [email protected]مسیر مطلق را با مسیر سورس خود جایگزین کنید و نام فایل خروجی npm pack را به کار ببرید. برای نمونه‌های Node، در package.json برنامه مقدار "type": "module" بگذارید یا از فایل .mjs استفاده کنید. فایل‌های src/ و dist/ را مستقیم وارد نکنید؛ از خروجی‌های عمومی بسته استفاده کنید.
وابستگی اختیاری موتور جستجو
خود بسته وابستگی زمان اجرا ندارد. موتورهای زیر وابستگی همتا و اختیاری هستند و برنامه مصرف‌کننده باید موتور مورد نیازش را نصب کند:
| موتور | بازه نسخه همتا | نسخه آزموده‌شده |
|---|---|---|
pagefind | ^1.5.0 | 1.5.2 |
@orama/orama | ^3.1.0 | 3.1.18 |
minisearch | ^7.0.0 | 7.2.0 |
flexsearch | ^0.8.0 | 0.8.212 |
lunr | ^2.3.0 | 2.3.9 |
رابط‌ها تابع‌های مورد نیاز یا شیء موتور را دریافت می‌کنند؛ نصب موتور را انجام نمی‌دهند. اتصال مرورگر به Pagefind از فایل تولیدشده pagefind.js استفاده می‌کند و رابط اختیاری اصلاح جستجو نیز همان فایل را از نشانی آن بارگذاری می‌کند.
نیازمندی‌های مرورگر
خروجی‌های عمومی را با ابزار ساخت برنامه به صورت ESM بستهبندی کنید. هدف کد ES2022 است و از عبارت‌های منظم با ویژگی‌های یونیکد، Map و آرایه‌های نوعدار استفاده می‌شود. بارگذاری واژه‌های اصلاح جستجو به fetch، Response، Blob، جریان داده و DecompressionStream("gzip") هم نیاز دارد. فهرست رسمی مرورگرهای قدیمی پشتیبانی‌شده تعریف نشده است. مسیرهای مخصوص Node یعنی /pagefind/build و /rescue/build را وارد بسته مرورگر نکنید. راهنمای بارگذاری را ببینید.
بازبینی وبسایت و انتشار
قرارداد انتشار، بازبینی فایل‌ها پیش از ثبت تغییرات را پشتیبانی می‌کند. برای نمایش درست این کتابخانه در مسیر docs:local، بارگذار فعلی وبسایت هنوز به ثبت مخزن و اصلاح CLI که در رفع مشکل آمده نیاز دارد. دریافت عمومی مستندات به انتشار GitHub، از جمله پیشانتشار برچسبدار، نیاز دارد. ساخت عادی وبسایت از نسخه ثبت‌شده مستندات استفاده می‌کند و تغییرات محلی یا آخرین وضعیت شاخه را دریافت نمی‌کند. این راهنما هیچ بسته npm یا انتشار GitHub ایجاد نمی‌کند.