الصفحة الرئيسية>المتعلقة بالبرمجة>مكونات الطرف الثالث
تنزيل

INGITE UI DOCFX Site Builder

يستخدم هذا المشروع node.js و gulp كأداة بناء لتسريع تطوير موقع عينات unge docfx ignite لإشعال واجهة المستخدم للزاوي.

المتطلبات الأساسية

  1. docfx
  2. node.js
  3. صافي SDK 6.0 أو أعلى

ابدء

تثبيت docfx

لتثبيت docfx ، استعدها كأداة dotnet - يقوم بتثبيت الأدوات المحلية .NET الموجودة في نطاق الدليل الحالي: 

dotnet tool restore

ملاحظة : يؤدي تنفيذ npm install أيضًا إلى استعادة تبعيات أداة dotnet كخطوة postinstall .

تثبيت تبعيات Node.js:

إذا كنت تستخدم NPM ، قم بتشغيل: 

npm install

إذا كنت تستخدم الغزل ، قم بتشغيل: 

yarn install

بدء خادم التطوير

تعتمد عملية الإنشاء على NODE_ENV المتغير للبيئة لتتمكن من تعيين عنوان URL الصحيح للعينات الزاوية. تعيين إما development أو staging أو production إلى NODE_ENV .

يمكنك إنشاء ملف .env تحت جذر المشروع وتعيين NODE_ENV ، على سبيل المثال ، عن طريق تعيين البيئة. 

 NODE_ENV=development

لبدء الخادم ، قم بتشغيل:

للغة الإنجليزية: 

npm start -- --lang en

ل japansese: 

npm start -- --lang jp

للكوري: 

npm start -- --lang kr

يأخذ الأمر وسيطة adittional -Lang [en | JP | KR] لخدمة النسخة الإنجليزية أو اليابانية أو الكورية.

بناء الموقع الثابت

للغة الإنجليزية: 

npm run build -- --lang en

لليابانية: 

npm run build -- --lang jp

للكوري: 

npm run build -- --lang kr

ينتج برنامج Build Script مجلد يسمى _site بجذر المشروع المعني. على سبيل المثال ، في اللغة الإنجليزية ، يعيش الموقع الثابت تحت en/_site ؛

بناء للتشغيل والإنتاج

يشبه أمر البناء الخطوة المذكورة أعلاه. لبناء موقع التدريج ، قم بتشغيل: 

npm run build-staging --lang en

أمر بناء التدريج هو: 

npm run build-production --lang jp

باستخدام محرر صريح لعينات التحرير المباشر

تسمح سمة محرر الصريح لعناصر عرض الكود بتعيين محرر مباشر بشكل صريح للعينة المحددة ويدعم "CSB" و "StackBlitz" كقيم. 

 < code-view explicit-editor =" csb " ... > </ code-view > 
 < code-view explicit-editor =" stackblitz " ... > </ code-view >

تضمين ملصقات TOC Topic

مفتوح '[en | JP | KR] Components TOC.IML 'للحصول على إصدار اللغة المحددة. يتضمن كل موضوع TOC معلمات للاسم و HREF ، إلى جانب معلمة تسمية اختيارية. بدءًا من الإصدار 3.5.1 من igniteui-docfx-template ، تشمل الملصقات المدعومة "الجديدة" و "المعاينة" و "المعاينة" و "بيتا". لإضافة التسمية المطلوبة ، ما عليك سوى تحديد اسمه وضبط قيمته على TRUE.

مثال: 

 - name: Update guide
  href: general/update-guide.md
  updated: true

قصاصات الرمز القابلة للطي

لإنشاء وعرض قصاصات الرموز القابلة للطي على مواقع التوثيق ، اتبع هذه الخطوات:

  1. قم بإنشاء قسم <div> مع الفئة "Deach-Details".

  2. أضف عنصر <summary> إلى قسم <Div> الذي تم إنشاؤه.

  3. أضف النص الموجز الذي يمثل رأس قصاصة الكود إلى عنصر <summary>.

  4. أضف عنصر <Code> إلى قسم <Div> الذي تم إنشاؤه.

  5. أضف مقتطف الرمز إلى عنصر <Code>.

  6. مثال: 

 < div class =" fancy-details " >
    < summary > Example of a successful response body: </ summary >
    < code >
        {
            "id": "{123456}_repo",
            "modified": "2023-02-03T14:07:34.0000000",
            "created": "2023-02-03T14:07:34.0000000",
            "name": "Marketing",
            "user": {
                "id": "{123456}_u ",
                "name": "Teddy Mitkova"
            },
            "dashboardSections": [
                {
                    "id": "{123456}_f",
                    "name": "May"
                }
            ]
        }
    </ code >
</ div >
يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل