cortexjs.io cortexjs.io

cortexjs.io

مكونات الطرف الثالث

1.0.0

تنزيل

يحتوي هذا الريبو على الملفات المصدر لموقع "cortexjs.io".

TL ؛ د

لأول مرة بعد استنساخ المشروع أو بعد إجراء بعض التغييرات المصدر

git submodule init

git submodule update

# Setup, make a dev build and start a server
npm start

لتحديث الوثائق بعد إصدار جديد

 # Pick-up changes in the dependent modules
npm run update

# Generate .md files for API and launch local server
npm start

لتنظيم التحديث ونشره

npm run stage
# Make a clean production build.
# Output goes inside submodules/cortex-js.github.io

npm run restart
# Validate that everything works well in the browser then...

npm run deploy
# submodules/cortex-js.github.io (a git submodule) gets pushed to cortex-js.github.io

بنيان

يتم نشر الموقع باستخدام صفحات جيثب. الفائدة الرئيسية لاستخدام صفحات GH هي تكامل سير العمل (Pubshing to GH يؤدي إلى تحديث تلقائي للموقع الذي يتم تقديمه)

يتم تأليف محتوى المواقع في المقام الأول كملفات تخفيض ، تتم معالجتها مع eleventy لتحويلها إلى HTML/CSS.

تكوين eleventy الرئيسي هو في ملف config/eleventy.js ، بما في ذلك تعريف التمييز للاستخدام.

محرك Markdown هو markdown-it الذي ينفذ علامة مشتركة.

يسمح المكون الإضافي mardown-it-attrs بتصميم الفقرات ، على سبيل المثال

هذا إشعار. {. notice-info}

يدعم المكون الإضافي لـ markdown-it-deflist قوائم تعريف نمط PANDC:

 Term 1
:   Definition 1
:   Second definition

الناتج في الدليل submodules/cortex-js.github.io . هذا الدليل هو وحدة فرعية git مرتبطة بـ cortex-js.github.io repo. أن Repo هو الذي تم نشره بواسطة صفحات GH (بالنسبة للمنظمة ، يمكن نشر ريبو بأكمله فقط ، للمشاريع ، يمكن احتواء المحتويات في دليل A /docs ).

انظر أيضا النموز الفرعية.

يجب أن يتضمن repo cortex-js.github.io أيضًا ملفين إضافيين:

.nojekyll الذي يشير إلى github أنه يجب ألا يعالج محتوى هذا الريبو مع jekyll (لأن هذا هو بالفعل الإخراج من jekyll)
CNAME مع محتوى cortexjs.io

يتم إنشاء هذه الملفات عند تشغيل npm run stage .

استخدم علامة التبويب "الإعدادات" في قشرة cortex-js.github.io لإشارة إلى استخدام مجال مخصص.

بالإضافة إلى ذلك ، يجب أن تتضمن إدخالات DNS لـ cortexjs.io ما يلي:

سجل CNAME يشير إلى www.cortex-js.io إلى cortex-js.io
أربعة سجلات تشير إلى
- 185.199.108.153
- 185.199.109.153
- 185.199.110.153
- 185.199.111.153

محتوى

يقوم الأمر npm run build بإنشاء وثائق واجهات برمجة التطبيقات من ملف TypeScript .d.ts في build/ الدليل.

تستخدم عملية الإنشاء أداة typedoc لتحليل ملفات رأس API وإخراج ملفات json في build/ الدليل.

ملاحظة: لتصحيح المحول ، استخدم مصحح VSCODE. حدد تصحيح> ابدأ تصحيح الأخطاء لبدء جلسة تصحيح الأخطاء في VSCODE.

يقوم برنامج build-guides Script بعد ذلك بتحويل ملف json إلى Markdown في دليل ./src/build ، والذي يمكن معالجته بعد ذلك برفقة مع npm run build أو npm start .

يتم تعريف معلومات التصميم CSS في src/_sass/ .

يجب أن تتبع وثائق API دليل نمط توثيق Google (https://developers.google.com/style/api- Reference-comments) و https://developers.google.com/style

بالإضافة إلى ذلك ، يجب أن يتبع رمز TypeScript دليل نمط Google: https://google.github.io/styleguide/jsguide.html#naming