Mintlify: عاين المستندات محليًا باستخدام mint CLI

لمن تناسب

إذا كنت تصون مستندات Mintlify وتريد رؤية الأثر على هذا الجهاز قبل الدفع إلى الخط، فهذا المستودع الرسمي للمستندات يناسب. هو Official Mintlify documentation. المستودع هو

https://github.com/mintlify/docs

وموقع المستندات المنشور هو

https://mintlify.com/docs

وحزمة CLI هي

https://www.npmjs.com/package/mint

الأنسب من لديه مجلد مستندات فيه docs.json (هذا المستودع المستنسخ أو مشروع Mintlify الخاص بك)، ويستطيع تشغيل npm على هذا الجهاز، ويقبل أمر التثبيت الرسمي هذا فقط: npm i -g mint. هذا CLI عام وليس حزمة سوق مهارات؛ لا تعِد كتابته إلى skills add.

إن أردت القراءة في المتصفح فقط

https://mintlify.com/docs

ولم تنوِ تعديل المستندات ولا فتح معاينة محلية، فلا حاجة إلى CLI. في المرة الأولى اجعل المعاينة المحلية فقط. لا تشغّل أمر طرح غير ظاهر في هذه الصفحة. هذه الصفحة لا تسمي أي عميل برمجة؛ انظر المعاينة في المتصفح.

أول محاولة في 3 دقائق

استخدم مسار التثبيت الرسمي هذا فقط:

npm i -g mint

التثبيت العام يغيّر سطر أوامر هذا الجهاز. أكّد أولًا أنك تقبل حزمة عامة. لا تبحث عن إضافة أو سوق.

الشروط المسبقة: Node/npm مثبت؛ مجلد العمل الحالي هو جذر المستندات، أي الطبقة التي ترى فيها docs.json. إن لم يوجد ذلك الملف بعد فاستنسخ مستودع المستندات الرسمي أولًا. لا تختلق docs.json بتنسيق غير موثّق.

ثم نفّذ في ذلك الجذر:

mint dev

هذا يبدأ معاينة محلية وهو عملية محلية. أكّد أن المنفذ للوصول المحلي فقط ثم نفّذ. افتح في المتصفح العنوان المحلي الذي يطبعه وتحقق أن صفحة مستندات واحدة تُرسم.

إشارة النجاح: أمر mint يعمل، وبعد mint dev ترى في المتصفح شجرة مستندات تطابق docs.json لا خطأ غياب docs.json. إن قال إنك لست في جذر المستندات فانتقل بـ cd إلى المجلد الذي يحتوي docs.json وأعد التشغيل؛ لا تضف وسائط غير موثّقة. إن لم يوجد mint فعد إلى npm i -g mint؛ لا تبدّل إلى اسم حزمة غير مكتوب.

حالات استخدام

الحالة 1: ثبّت Mint CLI. رسميًا ثبّت بـ npm i -g mint لمعاينة تغييرات المستندات محليًا. بعد التثبيت شغّل mint في الطرفية وأكّد أن الأمر دخل PATH. هذا أثر جانبي عام؛ لا تثبّته عشوائيًا في بيئة غير موثوقة. هذه الصفحة لا تكتب رقم إصدار ولا بديل npx mint؛ إن نقصت فاستخدم هذا التثبيت العام فقط.

الحالة 2: عاين في جذر المستندات. رسميًا شغّل mint dev في جذر المستندات (حيث يوجد docs.json). غيّر عنوانًا أو فقرة في صفحة md موجودة، احفظ، وانظر هل تتحدث المعاينة المحلية. لا تدفع طرحًا في المحاولة الأولى. هذه الصفحة لا تكتب تفاصيل إعادة التحميل الحي ولا منفذًا افتراضيًا؛ خذ عنوان المعاينة من خرج سطر الأوامر ولا تخمّن.

حدود الاستخدام

هذا مستودع المستندات الرسمي مع معاينة CLI، وليس مولّد مواقع ثابتة عامًا. بلا docs.json لا نقطة انطلاق رسمية لـ mint dev.

التثبيت الرسمي هو npm i -g mint فقط. mint dev معاينة وليس مثبّتًا ثانيًا. لا تختلق تثبيت سوق مهارات. الموقع المنشور مرجع للقراءة فقط وليس مصدر تثبيت.

الحزمة العامة وتشغيل dev لهما آثار جانبية. أكّد المجلد أولًا. هذه الصفحة لا تعطي خطوات نشر أو استضافة أو نطاق مخصص؛ لا تفعل أفعال طرح غير مكتوبة. ولا تسرد أوامر mint الفرعية الأخرى؛ لا تخمّن أوامر لم تظهر.