الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

docs.bsky.app

يحتوي هذا المستودع على الكود المصدري لموقع وثائق مطور Bluesky: https://docs.bsky.app

يتضمن هذا الموقع برامج تعليمية ومدونة وأدلة ومستندات مرجعية لـ HTTP API لتطبيق Bluesky.

تعد وثائق ومواصفات بروتوكول AT موقعًا منفصلاً (atproto.com) تتم صيانته على https://github.com/bluesky-social/atproto-website.

بناء المستندات

تم إنشاء موقع الويب هذا باستخدام Docusaurus، وهو منشئ مواقع ويب ثابت بلغة JavaScript.

لإنشاء الموقع، ستحتاج أولاً إلى تثبيت Node.js و npm محليًا. قم بتشغيل npm install لجلب التبعيات.

لتشغيل خادم تطوير محلي (والذي يمكنك تصفحه على http://localhost:3000): 

 npm start

لتشغيل بناء ثابت (الإخراج في ./build/ ): 

 npm run build

يمكن تقديم الإخراج باستخدام أي خدمة استضافة محتويات ثابتة.

تحديث مرجع HTTP API

نحن نستخدم نسخة متشعبة من atproto-openapi-types لإنشاء مخطط OpenAPI من قواميس atproto. نحن نستخدم البرنامج المساعد docusaurus-openapi-docs لتحويل مخطط OpenAPI الناتج إلى ملفات MDX.

يتطلب تشغيل عملية إنشاء MDX استخدام deno .

كود المصدر لهؤلاء المساعدين موجود في ./atproto-openapi-types/ .

ملفات المعجم الأولية موجودة في atproto-openapi-types/lexicons/ ، مع برنامج نصي مساعد ( get-lexicons.sh ) والذي يتم تشغيله تلقائيًا بواسطة Github CI كل يوم.

لإعادة إنشاء ملف OpenAPI: 

 deno task run

لإعادة إنشاء كافة ملفات MDX من ملف مخطط OpenAPI: 

 npm run clear-and-gen-api-docs

يمكنك اختبار صحة الإخراج: 

 npx docusaurus-mdx-checker

بعد ذلك، ستتحقق عادةً من إمكانية إنشاء الموقع بأكمله (وهذا بطيء): 

 # local dev server for preview
npm start

# or for a static build
npm run build

ترخيص المستندات

نص التوثيق موجود ضمن Creative Commons Attribution (CC-BY).

توجد أمثلة التعليمات البرمجية المضمنة وبيانات الأمثلة والتعبيرات العادية ضمن Creative Commons Zero (CC-0، المعروف أيضًا باسم Public Domain) ويتم نسخها/لصقها بدون إسناد.

يرجى الاطلاع على LICENSE.txt مع التذكيرات حول الأعمال المشتقة، وLICENSE-CC-BY.txt للحصول على نسخة من النص القانوني للترخيص.

يوسع
معلومات إضافية
تطبيقات ذات صلة
نوصي لك
أخبار ذات صلة الكل