Symbool-transclusie
Embed live code in uw documentatie op naam, niet op regelnummer. Bewerk de bron en uw documentatie wordt automatisch bijgewerkt.
# Embed een functie op naam
![[auth.py#validate_token]]Ohai haalt de functie validate_token uit auth.py en rendert deze inline met syntax highlighting. Wanneer de functie verandert, wordt uw documentatie automatisch bijgewerkt.
Waarom dit belangrijk is
Traditionele documentatie veroudert. U kopieert code naar markdown, de code evolueert, en plotseling liegt uw documentatie tegen u. Symbool-transclusie lost dit op door uw bronbestanden als de enige bron van waarheid te behandelen.
In tegenstelling tot regelnummerverwijzingen die bij elke refactoring breken, gebruikt symbool-transclusie AST-parsing om code te vinden op basis van de daadwerkelijke naam—functies, klassen, structs, constanten. Hernoem een bestand, reorganiseer uw code, voeg nieuwe methoden toe—zolang de symbolische naam bestaat, blijft uw documentatie accuraat.
Toepassingen
API-documentatie
Verwijs naar uw daadwerkelijke functiehandtekeningen, niet naar handmatig getypte benaderingen die uit sync raken.
Architecture Decision Records
Embed de code die u bespreekt in ADR's. De voorbeelden blijven actueel terwijl de codebase evolueert.
Onboarding-handleidingen
Laat nieuwe ontwikkelaars zien hoe authenticatie werkt met live code waarvan ze kunnen vertrouwen dat het overeenkomt met de repository.
Code-reviews
Haal specifieke functies in een markdown-samenvatting voor asynchrone review en discussie.
Tutorials
Loop door echte implementaties. Lezers kunnen erop vertrouwen dat de codevoorbeelden altijd up-to-date zijn.
Runbooks
Embed de exacte configuratie of het script waarnaar ops moet verwijzen tijdens incidenten.
Ondersteunde talen
30+ talen via Tree-sitter AST-parsing. Zelfs JSON-sleutels, YAML-paden en TOML-tabellen.
Klaar om documentatie te proberen die nooit veroudert?
Download voor Mac