2 dépôts
Capabilities for linking rendered documentation directly to the corresponding source files in version control.
Distinct from Version-Controlled Documentation: Distinct from Version-Controlled Documentation: focuses on the navigation link from the rendered page to the source code, not the storage of the docs.
Explore 2 awesome GitHub repositories matching development tools & productivity · Source Code Linking. Refine with filters or upvote what's useful.
Ce projet est un thème de documentation Sphinx responsive qui fournit une mise en page visuelle et un ensemble de templates Jinja2 pour rendre le contenu technique dans une interface web cohérente. Il fonctionne comme un framework de documentation CSS conçu pour adapter la présentation des manuels techniques aux écrans de bureau et mobiles. Le thème inclut une mise en page structurée spécifiquement pour les références d'API logicielles, formatant les signatures de fonctions, les paramètres et les types de retour. Il fournit également des mécanismes intégrés pour le lien vers le contrôle de version, permettant aux pages de documentation de pointer directement vers les fichiers sources sur des hébergeurs externes. Le projet couvre une large gamme de formatage de contenu technique, incluant des blocs de code avec coloration syntaxique, des équations mathématiques, des tableaux de données et des encadrés catégorisés pour les notes et avertissements. Il prend en charge le branding du site via des logos personnalisés et permet la modification des menus de navigation ainsi que l'injection d'assets CSS ou JavaScript personnalisés. Le thème s'intègre directement dans le processus de build Sphinx pour transformer le reStructuredText et le Markdown en sortie HTML thématisée.
Links documentation content directly to source files in version control systems for easier navigation.
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
Creates automated links from rendered documentation pages directly to specific line numbers in the version control repository.