Awesome GitHub RepositoriesAPI Reference Generators

Nextra is a documentation framework for Next.js that functions as an MDX static site generator. It enables the creation of structured technical documentation sites by transforming MDX files into themed static pages with built-in layout and navigation. It serves as a React-based documentation tool that allows the integration of custom React components directly into markdown content. The framework distinguishes itself through integrated full-text search and a localization system that manages multilingual content via language routing and translation selectors. It also includes an AI-powered chat

api-blueprint is a markdown-based API design language and specification standard used to define the structure, behavior, and data schemas of HTTP web services. It provides a formal method for mapping HTTP methods to resources and defining payload validation rules through a machine-readable syntax. The project functions as a blueprint for creating interactive technical documentation and functional mock servers. These tools transform design specifications into human-readable guides and simulated backend environments to enable integration testing before implementation. The language covers API m

TypeDoc is a documentation generator and AST analyzer that transforms TypeScript source code and comments into structured API reference websites or data files. It functions as a static site generator that converts code symbols into a searchable web interface. The project is an extensible framework, allowing users to modify the documentation process and generator logic through a programmable plugin system and custom themes. Its capabilities include API reference generation, source code parsing, and documentation coverage validation to ensure exported members are properly described. It support

Sphinx is an extensible documentation framework and multi-format document publisher. It serves as a technical content organizer that converts reStructuredText markup and Python source code comments into structured documentation for technical projects. The system transforms a single set of markup files into multiple output formats, including HTML, LaTeX, EPUB, and Texinfo. It functions as a Python API documentation tool, extracting documentation directly from source code to maintain synchronized technical reference manuals. The framework organizes complex information into hierarchies with aut

Jazzy is a source code documentation tool and API generator designed for Swift and Objective-C. It analyzes project roots and compiled modules to produce searchable HTML websites or offline docsets. The system functions as a multi-module API documenter, aggregating documentation from separate source modules into a single site with cross-module linking. It serves as a markdown-based documentation engine that integrates technical guides and LaTeX mathematical equations to complement generated API references. The tool covers a broad capability surface including multi-language API generation for

Doxygen is a source code documentation generator and multi-language API reference tool. It extracts annotated comments from source code to create structured technical manuals and searchable software libraries in formats including HTML, LaTeX, and PDF. The project functions as a static code analysis visualizer, generating call graphs, class diagrams, and inheritance hierarchies to illustrate codebase structure. It also serves as an XML documentation export engine, producing structured metadata that can be transformed via XSLT or third-party tools. Beyond API extraction, the tool provides a Ma

Rushstack هي مجموعة أدوات شاملة لإدارة مستودعات TypeScript الكبيرة (monorepos)، توفر إطار عمل لأتمتة خط أنابيب البناء، وتنسيق التبعية، والتحليل الثابت. تعمل كمنسق بناء تزايدي ونظام إدارة مصمم للحفاظ على الاتساق والأداء عبر حزم متعددة في مساحة عمل مشتركة. يتميز النظام من خلال نموذج تنفيذ قائم على الرسوم البيانية غير الدورية الموجهة والتزايد القائم على تجزئة المحتوى، مما يضمن إعادة بناء المشاريع المتأثرة فقط. كما يعمل على تحسين تدفقات عمل التطوير عبر التخزين المؤقت لآثار البناء عن بعد مع تكاملات لـ S3 وAzure وHTTP، ويستخدم إدارة مساحة العمل القائمة على الروابط الرمزية (symlink) للرؤية الفورية للتغييرات المحلية. تغطي مجموعة الأدوات مجموعة واسعة من القدرات بما في ذلك تدفقات عمل الإصدار المؤتمتة، وتحليل عقد API، وفرض جودة الكود على مستوى المؤسسة من خلال ملفات تعريف التدقيق (linting) المعيارية. كما توفر دعماً واسعاً لتجميع الأصول، وتحويل TypeScript، وتوليد تعريفات النوع من مخططات JSON والأصول الثابتة. تشمل مجالات المرافق الإضافية إدارة التوطين، وتوليد إشعارات الترخيص، وتنسيق واجهات سطر الأوامر مع مخرجات العمليات المتزامنة.

هذا المشروع هو موقع التوثيق الرسمي لـ Kubernetes، ويعمل كمورد تقني شامل لإدارة التطبيقات المعبأة. يعمل كبوابة توثيق تقنية مفتوحة المصدر توفر أدلة، ودروسًا تعليمية، ومواد مرجعية لبرمجيات الأنظمة الموزعة. تم بناء الموقع باستخدام مولد مواقع ثابت مع بنية قالب قائمة على المكونات للحفاظ على أنماط تصميم متسقة. ويتميز بمولد توثيق OpenAPI الذي يحلل المواصفات التقنية لبناء وتحديث صفحات مرجع واجهة برمجة التطبيقات المهيكلة تلقائيًا. لدعم جمهور عالمي، يستخدم توجيه المحتوى الواعي بالتدويل لإدارة الإصدارات المترجمة من الأدلة. يتضمن سير عمل التطوير خادم إعادة تحميل ساخن لمعاينة تغييرات الموقع وعرض اللغة المستهدف لتسريع أوقات البناء. يغطي المشروع مجموعة واسعة من المجالات التقنية، بما في ذلك تنسيق العناقيد، وتهيئة الشبكة، وإدارة الموارد.

TSDoc هو معيار توثيق ومواصفات لكتابة التعليقات المهيكلة في كود TypeScript. يوفر نظاماً قابلاً للنقل لتعريف البيانات الوصفية، والوسوم، والمراجع التبادلية داخل الكود المصدري لضمان التحليل والعرض المتسق عبر الأدوات المختلفة. يتضمن المشروع محلل تعليقات توثيق يقوم بتحويل التعليقات إلى شجرة بناء جملة مهيكلة، ومدققاً يفرض اتساق بناء الجملة. يسمح بتعريف وسوم توثيق مخصصة من خلال ملفات تكوين خارجية ويدعم أوضاع التحقق من بناء الجملة المتعددة للمساعدة في الامتثال للمواصفات. تغطي المواصفات مجموعة واسعة من احتياجات توثيق API، بما في ذلك تحديد مراحل الإصدار، والاستقرار، والإهمال. تدعم تفصيل معاملات الدوال، وقيم الإرجاع، وأنواع الاستثناءات، بالإضافة إلى إدارة الرؤية الداخلية، والوراثة، والمراجع التبادلية بين الإعلانات.

Knife4j هي واجهة ويب محسنة لتصور والتفاعل مع مواصفات OpenAPI وSwagger. تعمل كواجهة مستخدم للتوثيق وأداة تصحيح أخطاء تقوم تلقائياً بإنشاء مراجع تقنية من كود مصدر Java وأطر عمل الويب. يتميز المشروع بقدرته على تجميع تعريفات API من خدمات مصغرة موزعة متعددة في بوابة توثيق موحدة واحدة. يؤمن هذه البوابة باستخدام تدفقات مصادقة OAuth2 ويوفر بوابة لتقييد الوصول إلى المواصفات التقنية وأدوات الاختبار. تتضمن المنصة قدرات لتصحيح أخطاء الطلبات مع اختبار المعلمات الديناميكي وإعادة توجيه الطلبات القائمة على الوكيل. كما تدعم إدارة المحتوى من خلال دمج ملفات Markdown الخارجية للأدلة التقنية التكميلية وتوفر أدوات لتخصيص واجهة الواجهة الأمامية.

Appledoc هو مولد توثيق لـ Objective-C ومولد مواقع ساكنة يقوم بتحليل تعليقات الكود المصدري لإنشاء توثيق HTML مهيكل. غرضه الأساسي هو إنشاء أدلة مرجعية احترافية للمطورين تلتزم بتوثيق أسلوب Apple الرسمي. تتميز الأداة بالدمج المباشر في عملية تجميع المشروع عبر نصوص برمجية آلية لمرحلة البناء، مما يضمن تحديث الأدلة التقنية مع تغير الكود. وتوفر تخصيصاً واسعاً من خلال قوالب HTML وCSS خارجية، بالإضافة إلى نظام تهيئة قائمة الخصائص (Property list) لإدارة الإعدادات العالمية وحل المسارات الديناميكي في وقت التشغيل. يغطي المشروع مجموعة واسعة من الإمكانيات بما في ذلك تحليل الكود المصدري لاستخراج توقيعات أعضاء API وتنظيم الدوال في أقسام مهيكلة. ويتميز بالإسناد الترافقي التلقائي بين الفئات والبروتوكولات، والقدرة على استيراد محتوى ساكن خارجي أو Markdown إلى الفهرس الرئيسي، وإنشاء مجموعات توثيق مفهرسة خصيصاً لبيئات التطوير المتكاملة. يتضمن النظام أيضاً أدوات لنشر إصدارات التوثيق عبر ملفات الأرشيف وتحديث خلاصات Atom، إلى جانب أدوات تصحيح الأخطاء للتحقق من الحالة النهائية المحلولة لإعدادات التهيئة.

Compodoc هو مولد توثيق API لـ TypeScript، ومولد مواقع ثابتة، ومصور معمارية المشروع. يقوم بتحليل الكود المصدري وتعليقات JSDoc لإنشاء مواقع مرجعية تقنية قابلة للبحث، وكتالوجات API، وصفحات HTML مستقلة. يتميز المشروع بتحليل عبارات الاستيراد لإنتاج رسوم بيانية للتبعيات وخرائط الوحدات التي توضح العلاقات الهيكلية داخل قاعدة الكود. يتضمن دعماً متخصصاً لتصور مشاريع Angular، وسير عمل NestJS، ومكونات Stencil للويب، ويمكنه تضمين عروض توضيحية حية مباشرة في صفحات التوثيق. يعمل النظام أيضاً كمحلل لتغطية التوثيق، حيث يوفر تقارير ويفرض حد أدنى من عتبات التغطية داخل خطوط أنابيب التكامل المستمر (CI) لإفشال عمليات البناء إذا كانت مستويات التوثيق غير كافية. تشمل القدرات الإضافية تكامل Markdown، وتصدير البيانات بتنسيقات متعددة إلى JSON أو Markdown، وخادم تطوير محلي مع مراقبة نظام الملفات لإعادة البناء التلقائي. يمكن للمستخدمين تخصيص المخرجات من خلال ملفات التكوين، وتصميم CSS مخصص، وتصفية رؤية العناصر لاستبعاد رموز معينة أو علامات داخلية من الموقع النهائي.

hugo-book is a documentation theme and static site framework for Hugo designed to create structured technical manuals, documentation books, and multilingual knowledge bases. It transforms directory structures into hierarchical navigation menus and formatted technical content. The framework includes a specialized OpenAPI documentation renderer that converts specifications into structured reference pages. It also provides a full-text client-side search integration and supports multilingual content with right-to-left layout mirroring. The project covers a wide range of content rendering capabil

dumi is a static site generator and markdown-based documentation tool specifically designed for software component libraries. It transforms markdown files and source code into structured technical guides and API references. The project distinguishes itself by providing an interactive component playground that renders live, runnable code demos directly in the browser. It includes an automated API reference generator that parses source code to create documentation tables and property descriptions. Additionally, it supports a monorepo documentation workflow with source mapping and hot module rep