عن المشروع

Material for MkDocs هو إطار عمل للتوثيق مبني فوق MkDocs، وهو مولد مواقع استاتيكية. الهدف المعلن للمشروع هو السماح للمؤلفين بكتابة التوثيق بلغة Markdown والحصول على موقع استاتيكي احترافي وقابل للبحث لمشروع مفتوح المصدر أو تجاري في وقت قصير، دون الحاجة إلى التعامل مباشرة مع HTML أو CSS أو JavaScript. الخصائص الأساسية الموضحة في ملف README: تأليف يعتمد أولاً على Markdown. يتم كتابة المحتوى بلغة Markdown، ويتولى إطار العمل عملية الرندرة وتوليد الموقع. لا تتطلب عملية إنتاج موقع توثيق منشور أي معرفة مسبقة بالواجهات الأمامية. مخرجات متجاوبة. يتكيف الموقع المولد مع حجم الشاشة المتاح، مما يغطي العرض على أجهزة الكمبيوتر المكتبية والأجهزة اللوحية والهواتف المحمولة. التخصيص. يمكن تغيير الألوان والخطوط واللغة والأيقونات والشعار من خلال الإعدادات، ويوفر إطار العمل خيارات لتعديل المظهر والسلوك، وهو ما يوصف بأنه قابل للتوسيع بسهولة. الأداء والبصمة. يتم تقديم القالب على أنه سريع وخفيف الوزن، مع أهداف معلنة لتحقيق تصنيف جيد في محركات البحث وجذب الزوار العائدين. الملكية والتحكم. نظراً لأن المصادر ومخرجات التوثيق تظل في يد المستخدم، يسلط المشروع الضوء على فوائد النزاهة والأمان مقارنة باستضافة معرفة المنتج على منصات تابعة لجهات خارجية. التدويل. يذكر ملف README دعم أكثر من 60 لغة. عمليات التثبيت والتكوين بسيطة بشكل متعمد. يتم تثبيت الحزمة من PyPI عبر الأمر `pip install mkdocs-material` وتفعيل القالب بإضافة سطرين إلى mkdocs.yml: theme: name: material كما تتوفر صورة Docker منشورة على Docker Hub تحت مساحة الاسم squidfunk/mkdocs-material. تتوفر تعليمات إعداد مفصلة وخيارات تكوين وعرض حي على موقع توثيق المشروع في squidfunk.github.io/mkdocs-material. يشير ملف README إلى أن المشروع مبني بتقنيات مفتوحة المصدر ومرخص بموجب رخصة MIT، حقوق الطبع والنشر 2016-2025 لـ Martin Donath. الاعتماد. يسرد ملف README مجموعة واسعة من المؤسسات والمشاريع التي تستخدم القالب لتوثيقها، من بينها أسماء صناعية مثل ArXiv وAtlassian وAWS وBloomberg وCERN وDatadog وGoogle وHarvard وHewlett Packard وHSBC وING وIntel وJetBrains وLinkedIn وMicrosoft وMozilla وNetflix وOpenAI وRed Hat وSalesforce وSiemens وSlack وSquare وUber وZalando، إلى جانب مشاريع مفتوحة المصدر تشمل Apache Iceberg وArduino وAsahi Linux وAutoKeras وCentOS وCrystal وeBPF وejabberd وElectron وFastAPI وFlatBuffers و{fmt} وFreqtrade وGoReleaser وGraphRAG وHeadscale وHedgeDoc وHummingbot وKnative وkSQL وLeakCanary وLlamaIndex وNetBox وNokogiri وOpenFaaS وOpenSSL وOrchard Core وPercona وPi-Hole وPolars وPydantic وPyPI وQuivr وRenovate وRetroPie وRuff وTraefik وTrivy وTyper وtinygrad وUltralytics وUV وVapor وWebKit وWTF وZeroNet. كما يقر ملف README بمجموعة من الرعاة الفضيين والبرونزيين الذين تظهر شعاراتهم على الصفحة. باختصار، يستهدف Material for MkDocs الفرق والمشرفين الذين يرغبون في موقع توثيق استاتيكي خاضع لسيطرتهم وقابل للتكوين يتم توليده من ملفات Markdown بسيطة، مع مسار تثبيت يتكون من تثبيت حزمة واحدة ومقتطف تكوين قصير.