Awesome GitHub RepositoriesDocumentation Frameworks

Slate is a static API documentation generator and developer documentation framework. It transforms API specifications and text files into a formatted static website designed for hosting API references and guides. The system functions as a static site generator that builds a developer portal without the need for a backend database. It manages API reference details by organizing technical endpoints into a readable format and providing a structured layout for developer consumption. The framework covers content generation and site architecture, including the compilation of markdown guides and th

Docsify is a client-side documentation framework and no-build static site generator. It functions as a browser-based engine that converts Markdown files into HTML on the fly, allowing for the generation of documentation websites without a static build or compilation process. The system employs a plugin interface and lifecycle hooks to modify the rendering process and extend site capabilities. It supports dynamic theme injection and visual style customization through external CSS and layout configurations. The framework includes capabilities for multi-language content management, full-text se

VitePress is a static site generator designed for building documentation-focused websites. It functions as a framework that transforms markdown source files into pre-rendered HTML, utilizing file-based routing to map document paths directly to site URLs. By leveraging the Vue ecosystem, it enables the creation of content-heavy sites that combine static delivery with dynamic interactivity. The framework distinguishes itself by allowing developers to embed interactive components directly into markdown files, which are then transpiled into executable code modules. It optimizes the user experienc

Markdoc is a documentation content framework that extends standard Markdown with custom tags, typed schemas, and reusable components, parsing content into an abstract syntax tree and rendering it as React elements or HTML. It provides a structured authoring system where documents are processed through an AST-based pipeline, enabling validation, transformation, and flexible output generation. The framework distinguishes itself through a schema-driven validation pipeline that checks document structure and attribute values against defined rules, and a pluggable renderer architecture that accepts

Codehike este un framework de documentație bazat pe React și un instrument interactiv pentru walkthrough-uri de cod. Acesta funcționează ca un orchestrator de conținut markdown care transformă markdown-ul decorat în date structurate și componente React, servind drept strat de vizualizare pentru evidențierea secțiunilor de cod, a diferențelor (diffs) și a erorilor de compilare. Proiectul se distinge prin capacitatea de a crea experiențe de tip "scrollycoding" și tutoriale tehnice pas cu pas. Dispune de animații la nivel de token care demonstrează vizual modul în care logica evoluează între versiunile de cod și oferă un sistem pentru sincronizarea stării UI cu poziția de scroll a browserului. Framework-ul acoperă o gamă largă de capacități de vizualizare, inclusiv crearea de slideshow-uri de cod, layout-uri de tip spotlight și blocuri de cod cu tab-uri. Suportă adnotarea detaliată a codului prin tooltips, callout-uri și note de subsol, precum și utilitare funcționale precum switchere de limbaj, transpilarea codului și integrarea datelor de compilare în timp real. Sistemul utilizează validarea bazată pe schemă pentru a asigura siguranța tipurilor și consistența datelor structurate extrase din fișierele markdown.