عن المشروع

github-markdown-css هي حزمة CSS صغيرة هدفها المعلن هو إعادة إنتاج النمط البصري الذي يطبّقه GitHub على Markdown المعروض، باستخدام أقل قدر ممكن من CSS. ورقة الأنماط مولّدة وليست محررة يدويًا؛ يشير ملف README إلى توجيه المساهمات إلى مستودع منفصل باسم generate-github-markdown-css. الاستخدام بسيط: استورد github-markdown.css، وأضف الكلاس markdown-body إلى الحاوية التي تحتوي على Markdown المعروض، واضبط العرض. يلاحظ ملف README أن GitHub يستخدم عرض 980px مع حشوة 45px، وحشوة 15px على الجوال، ويقدم مثالًا يتضمن box-sizing وmin-width وmax-width وmargin: auto واستعلام وسائط لوجهات العرض الضيقة. كما يُعرض لون خلفية للوضع الداكن عبر prefers-color-scheme. تتضمن الحزمة سبعة سمات: سمة افتراضية تتبدل تلقائيًا بين الفاتح والداكن عبر prefers-color-scheme، وسمة فاتحة فقط، وداكنة فقط، وداكنة خافتة، وداكنة عالية التباين، وداكنة لعمى الألوان (بروتانوبيا وديوتيرانوبيا)، ونسخ فاتحة لعمى الألوان. بخصوص HTML المتوافق مع هذه الأنماط، يقترح ملف README استخدام واجهة برمجة التطبيقات /markdown من GitHub، التي تُنتج HTML الذي يولّده GitHub نفسه. ويشير إلى أن محللات Markdown الأخرى ستعمل في الغالب مع هذه الأنماط أيضًا، ويوصي باستخدام starry-night لإبراز الكود بطريقة تحاكي GitHub. تشمل خيارات التثبيت تنزيل الملف يدويًا، أو استخدام CDNJS، أو أمر npm install github-markdown-css. كما توجد صفحة عرض تجريبي مرتبطة. ملاحظة حول استكشاف الأخطاء تشرح أن مشاكل التنسيق مثل خطوط الجداول السوداء في الوضع الداكن قد تنتج عن دخول المتصفح في وضع التوافق (quirks mode)؛ وإضافة إعلان نوع المستند (doctype) في أعلى الصفحة يتجنب ذلك. وللتطوير، يقوم الأمر npm run make بتحديث CSS.