Programmatically access Markdown documentation.
توفر الواجهة البرمجة لدليل ماركداون مجموعة فرعية من توثيقات دليل ماركداون بتنسيق JSON. نأمل أن يستخدم مطورو البرمجيات والمؤسسات هذه الواجهة البرمجية لاستهلاك توثيقنا البرمجي وعرضها في التطبيقات وعلى مواقع الويب.
لماذا إنشاء واجهة برمجية لتوثيقات ماركداون؟ بسبب وجود الكثير من توثيقات ماركداون المتكررة على الويب! يبدو أن كل شخص لديه نسخته الخاصة من توثيقات ماركداون لتطبيقه أو موقعه على الويب. هذا مؤسف لأن معظمه متماثل تمامًا.
ثم جاءت اللحظة الموعودة. 💡أدركنا أنه يمكننا إنشاء واجهة برمجية تستخدم JSON باستخدام التوثيق من دليل ماركداون. بهذه الطريقة، يمكن لمطوري البرمجيات البدء في استخدام الواجهة البرمجية لتضمين توثيقاتنا في تطبيقاتهم، ويمكن للمؤسسات مثل الجامعات والمكتبات استخدام هذه الواجهة البرمجية لتضمين توثيقاتنا على مواقعهم على الويب.
نود أن نرى أن دليل ماركداون أصبح مستودع التوثيقات المركزي لآلاف تعليمات ماركداون المنتشرة في جميع أنحاء الإنترنت. هل ستعمل؟ لا أحد يعرف ذلك يقينًا! هناك شيء واحد مؤكد على الرغم من ذلك: لا يمكننا الانتظار لمعرفة ما ستفعله به. 🤘
صُمّمت الواجهة البرمجية لدليل ماركداون لتوفير توثيقات ماركداون الأساسية فقط. نتيجة لذلك، لا تتضمن الواجهة البرمجية جميع التوثيقات المتاحة على موقع دليل ماركداون. مثلًا، لا يتوفر قسم إضافة العناصر للقوائم من خلال نقطة وصول القواعد الأساسية.
تحتوي نقطة وصول القواعد الأساسية على توثيق عناصر ماركداون الموضحة في مستند تصميم جون جروبر (John Gruber) والموضّحة في صفحة القواعد الأساسية.
curl https://www.guide.dawin.io/api/v1/basic-syntax.json
توفر نقطة الوصول للملّخص المرجعي نظرة عامة على عناصر ماركداون الأساسية والموسّعة الأكثر شيوعًا، كما هو موضح في صفحة الملخص المرجعي.
curl https://www.guide.dawin.io/api/v1/cheat-sheet.json
فيما يلي قائمة بجميع التغييرات التي أجريت على الواجهة البرمجية لدليل ماركداون.
2018-10-18
- حُدّثت نقطة الوصول للملخص المرجعي لتضمين معلومات حول قوائم التعريف (<dl>)
2018-07-12
- تحديث وصف الروابط لتضمين معلومات حول إضافة العناوين (titles) في وسم الروابط
2017-11-10
- إضافة نقطة وصول الملخص المرجعي
2017-11-04
لا تتوقف الآن! 🚀 قم بتمييز مستودع GitHub بنجمة ثم أدخل عنوان بريدك الإلكتروني أدناه لتلقي دروس Markdown التعليمية الجديدة عبر البريد الإلكتروني. نحن لا نرسل بريدا مزعجا!